Reports (Beta)

List reports

Returns a paginated list of report jobs scoped to the calling tenant.

Note: Download URLs are not included in list responses. Call GET /v1/reports/{reportId} to obtain a fresh signed download URL for a specific completed report.

Note: These endpoints are currently in beta and might be subject to changes.

Endpoint Permission: Viewer and above.

get/reports

Request

Query parameters

pageCursorstring

Opaque cursor returned from a previous list call

pageSizeinteger

Maximum number of items per page

sortBy'createdAt' | 'completedAt'

Field to sort by

order'ASC' | 'DESC'

Sort direction

statusReportStatus[]

Filter by lifecycle status. Repeat the parameter to filter on multiple statuses (e.g., ?status=QUEUED&status=PROCESSING).

[
  "QUEUED"
]
reportTypeReportType[]

Filter by report type. Repeat the parameter to filter on multiple types.

[
  "ADDRESSES"
]

Response

Paginated list of report jobs

nextstring nullable required

Opaque cursor for the next page. Null on the last page.

prevstring nullable required

Opaque cursor for the previous page. Null on the first page.

Example response

{
  "data": [],
  "next": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9",
  "prev": "eJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9"
}

Changes

No recorded changes to this operation across all 1 revision of this API.