Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Stock reports

Get stock report export by id

get/datainsights/v1.1/stock_reports/{stock_report_id}/export

Path parameters

stock_report_idinteger required

Stock report id of the resource

Query parameters

format'xlsx' | 'csv' | 'json' required
Example:xlsx

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

property_idsinteger[] required

Stock report property ids

view'details' | 'formatted' required
Example:details

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

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

OK

urlstring url

Url to get the exported report

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

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

view'details' | 'formatted'

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

filenamestring

Name of the file exported

generated_atstring

File generated at

Example response

{
  "url": "https://...",
  "format": "xlsx",
  "view": "details"
}