Skip to navigation
HelpersReports

List all Reports

List key data of Reporting Service reports

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Query parameters

StatusstringOptional

Possible values: PENDING, GENERATING, GENERATED, EXPIRED, FAILED

The status of the report:

  • PENDING – The report generation request was accepted but is not yet being processed.
  • GENERATING – The report is being generated.
  • GENERATED – The report is ready for download at the DownloadURL
  • EXPIRED – The report has expired and is no longer available for download.
  • FAILED – Report generation was not successful.
BeforeDateintegerOptional

The date before which the report was created (based on the report’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateintegerOptional

The date after which the report was created (based on the report’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

per_pageintegerOptional

Min. value: 1; max. value: 100

Default value: 10

Indicates the number of items returned for each page of the pagination.

pageintegerOptional

Start value: 1

Default value: 1

Indicates the index of the page for the pagination.

SortstringOptional

Possible values: CreationDate:ASC, CreationDate:DESC

Default value: CreationDate:ASC

Indicates the direction in which to sort the list.

Response

Success
Array (Reports)list of objectsOptional
The list of reports created by the platform.