/report
Internal Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /report | Retrieve summary information for each report. Optionally, filter the retrieved information. | Available | |
| POST /report | Create a new report by specifying one of the report templates. | mutuation createCustomReport | Restricted |
| GET /report/compliance_summary_24_hours | Returns the past 24 hour compliance summary information for all objects. | query snappableConnection | Restricted |
| POST /report/data_source/download | Create a job to generate data source CSV file in background. Returns a job id to poll the status of job. | Restricted | |
| POST /report/data_source/table | Returns the raw table data without constructing a report. | Restricted | |
| GET /report/data_source/{data_source_name}/csv | Retrieve a CSV file containing the raw table data from the specified data source. Retrieved data is not constructed as a report. Returns a download link for the CSV file. | Available | |
| GET /report/email_subscription/{subscription_id} | Returns the email subscription specified by subscription_id for the report it is a subscription of. | Available | |
| PATCH /report/email_subscription/{subscription_id} | Updates the email subscription specified by subscription_id for the report it is a subscription of. | Restricted | |
| DELETE /report/email_subscription/{subscription_id} | Deletes the email subscription specified by subscription_id for the report it is a subscription of. | Restricted | |
| POST /report/global_object_csv/download | Create a job to upload GlobalObject CSV file in background. Returns a job_id to poll the job status. | Restricted | |
| GET /report/global_object_csv_request/{job_id} | Retrieve details of an asynchronous request for uploading the CSV report file. | Available | |
| GET /report/request/{id} | Get the details of an asynchronous request that generates data source CSV download file. | Available | |
| GET /report/template | Get report template details for the template. | Restricted | |
| GET /report/{id} | Get report details and update status. | Available | |
| PATCH /report/{id} | Update a specific report. The report's name, chart parameters, filters and table can be updated. If successful, this will automatically trigger an async job to refresh the report content. | Restricted | |
| DELETE /report/{id} | Delete a specific report specified by reportId. | Restricted | |
| GET /report/{id}/chart | Retrieve chart data associated with the report specified by id. | Available | |
| GET /report/{id}/csv_link | Get the link to a CSV file for a report. This is a synchronous operation. | Available | |
| GET /report/{id}/email_subscription | Returns all email subscriptions for the report specified by ID. | Available | |
| POST /report/{id}/email_subscription | Creates an email subscription for the report specified by ID. | Restricted | |
| POST /report/{id}/refresh | Begins to refresh the data associated with the report specified by id. This should be used following calls to the various report patch endpoints in order to trigger the data update. | Restricted | |
| POST /report/{id}/send_email | Schedule a job to send an email for the report. | Restricted | |
| POST /report/{id}/table | Retrieve table data for a specific report. | Restricted |
v1 Endpoints
REST Endpoint |
Description |
GraphQL Query | CDM Availability |
|---|---|---|---|
| GET /report/compliance_summary | Returns the compliance summary information for all protected objects based on a time-based requirement of at least one snapshot in each 24 hour report period. This view ignores the policies assigned to protected objects through SLA Domains. | query snappableConnection | Available |
| GET /report/compliance_summary_sla | Returns the compliance summary information for all protected objects based on whether the last expected snapshot was successful. This requirement is based on the SLA Domain assigned to the objects. | query snappableConnection | Available |
| PATCH /report/config | Set the different report config parameters. | mutation updateReport | Restricted |