Create a report

Creates a new asynchronous report job and returns a receipt containing the report ID.
Poll GET /v1/reports/{reportId} to check status. When status is COMPLETED, the poll
response includes a fresh pre-signed download URL in links.downloadUrl.

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

Endpoint Permission: Viewer and above.

Body Params

Request body for creating a new ADDRESSES report job

string
enum
required

The type of report to generate.

Allowed:
string
enum
required

The output file format of the report

Allowed:
boolean
Defaults to false

Gzip the output file. Defaults to true.

filters
object

Filter options for the addresses report type.

Headers
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Responses

Language
URL
LoadingLoading…
Response
Choose an example:
application/json