v1
latestOpenAPI 3.0.32026-08-0658558.8 KBReports
List reports
Returns an array of reports available for download. Each array element represents an available report, and contains the reportId, reportType, and reportFormat fields associated with that report.
To get the download link for a specific report, store the reportId for the report you want, and use it with the Get a report operation.
get/v1/reports
Query parameters
created-by'USER' | 'SCHEDULER' | 'API'
Query for report types based on the entity that initiated report creation.
| Value | Description |
|---|---|
| SCHEDULER | Get automated system-generated reports. |
| USER | Customized reports generated by users through the UI. |
| API | Customized reports generated using the API. |
Example:USER
Response
Returns an array of report metadata for the calling tenant
Example response
{
"reports": [
{
"reportId": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"reportName": "My custom report",
"reportStatus": "READY",
"startDate": "2018-04-06T20:33:35Z",
"endDate": "2018-04-06T20:33:35Z",
"createdOn": "2018-04-06T20:33:35Z",
"reportCreatedBy": "Norma Jean"
}
]
}