v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Reports

Queue task to export report by id

post/datainsights/v1.1/reports/{report_id}/export/async

Path parameters

report_idinteger required

Report id of the resource

Query parameters

view'details' | 'formatted' required

Example:details

View: should be either 'formatted' or 'details'

format'xlsx' | 'csv' | 'json' required

Example:xlsx

Format: should be either 'xlsx', 'csv' or 'json'

include_chartsboolean

Example:true

Flag to include charts in the export, defaults to True

Headers

X-PROPERTY-IDinteger required

Property id of the client

Response

idstring

statusstring

Status of the task

errorstring

Error, if the task failed

Example response

{
  "id": "53cce75e-eed6-4040-8a98-8accf372947a",
  "status": "PENDING",
  "result": {
    "format": "xlsx",
    "view": "raw",
    "filename": "Report Name"
  }
}