Skip to main content
Skip table of contents

Reports

GET /v3/reports

Retrieve a list of available user reports.

CODE
Headers:
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials, login_info
Scopes: [reports]

Response body:
{
  "reports": [
    {
      "id": 0,
      "name": "string",
      "formats": "string"
    }
  ],
  "count": 0
}

POST /v3/reports/executions

Run report execution

Successful response contains the execution ID of the report generation. ExecutionId should be used to check report status and as an identifier to download generated report.

CODE
Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials, login_info
Scopes: [reports]

Request body:
{
  "id": 0,
  "format": "string"
}

Response body:
{
  "executionId": 0
}

GET /v3/reports/executions/{executionId}/download

Download the report file for a specific report execution.

CODE
Headers:
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials, login_info
Scopes: [reports]

Response body:
[report file as a binary]

Response codes:
200 - Successful response containing the report file.
202 - Report execution in progress
410 - Report execution failed
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.