Execute a Report

Scope

data-reports:write

Request Body

{
  "name": "string",
  "timezone": "string",
  "format": "csv",
  "timespan": {
    "from": "2022-03-23T11:42:17.312Z",
    "to": "2022-03-23T11:42:17.312Z"
  }
}

Request Fields

Field

Mandatory

Description

format

No

Format in which the report file will be created.
Three outputs are supported:

  • CSV (default format; with a header using separation column character of ,).
  • JSON (format encapsulated by an entries structure with a total count).
  • JSON_BULK (format indicated for large data volumes, each object is represented by a single line without any encapsulation (e.g.: JSON array)).

name

No

Report's name. It has 256 character limit.

timespan.from

Yes

Specifying the start datetime filter for the records to be retrieved from the report. Depending on the report, this field will be mapped to a specific datetime field for that report.

timespan.to

Yes

Specifying the end datetime filter for the records to be retrieved from the report. Depending on the report, this field will be mapped to a specific datetime field for that report.

timezone

Timezone in which the report timespan (from and to) will be applied. If not specified, will be used "UTC" as default value. Only IANA timezones are allowed, as mentioned in App and Data Types.

🚧

Report Availability and Data Latency

This file will be available for download for 30 days.

The data obtained via Explore API has a 60-second delay in relation to real time.

❗️

Account-based Quota

The Explore API has an account-based quota limit of 15 simultaneous reports (executing + enqueued). If this limit is exceeded, the user will receive a 429 (too many requests) response.

❗️

A Request to Execute a Report May Fail When

  • The credentials are not valid or the required scope is missing.
  • The report request:
    • Does not have a valid structure.
    • Is missing a mandatory field.
  • Some report request field has an invalid value (e.g.: invalid report format or not properly formatted date time).
  • The report's end date (timespan.to) is:
    • In the future.
    • Prior to the start date (timespan.from).
  • The difference in days between the end date (timespan.to) and the start date (timespan.from) is greater than 31.
  • The report's timezone is not a valid timezone. Only timezones that follows the IANA standard are allowed.
  • The account-based quota limit of 15 simultaneous reports (executing + enqueued) has been exceeded.
Language
Click Try It! to start a request and see the response here!