post https://example.com/datainsights/v1.1/stock_reports//query/export/async
Request a file export of data from any stock report json that is not created
Query stock report data from a stock report that is not created
Mode:
- Export: 100000 Records
Based on the report type
sent in the request, the data structure returned may have multiple formats.
Types
List
{
...
"columns": ...
"settings": {
...
"totals": false,
"transpose": false,
}
}
List (Totals)
{
...
"columns": ...
"settings": {
...
"totals": true,
"transpose": false,
}
}
PeriodList
{
...
"columns": ...
"periods": ...
"settings": {
...
"totals": false,
"transpose": true|false,
}
}
Summary
{
...
"columns": ...
"group_rows": ...
"settings": {
...
"totals": false,
"transpose": true|false,
}
}
Summary (Totals)
{
...
"columns": ...
"group_rows": ...
"settings": {
...
"totals": true
"transpose: true|false,
}
}
PeriodSummary
{
...
"columns": ...
"group_rows": ...
"periods": ...
"settings": {
...
"totals": false,
"transpose": true|false,
}
}
Pivot
{
...
"columns": ...
"group_rows": ...
"group_columns": ...
"settings": {
...
"totals": false,
"transpose": true|false
}
}
Pivot (Totals)
{
...
"columns": ...
"group_rows": ...
"group_columns": ...
"settings": {
...
"totals": true,
"transpose": true|false,
}
}
Data
Type | Headers | Index | Records | Group Rows | Group Columns | Totals | Periods | Transpose |
---|---|---|---|---|---|---|---|---|
List | Yes | No | Yes | No | No | No | No | No |
List (Totals) | Yes | No | Yes | No | No | Yes | No | No |
PeriodList | Yes | Yes | Yes | No | No | No | Yes | Yes |
Summary | Yes | Yes | Yes | Yes | No | No | No | Yes |
Summary (Details) | Yes | Yes | Yes | Yes | No | Yes | No | No |
Summary (Totals) | Yes | Yes | Yes | Yes | No | Yes | No | Yes |
PeriodSummary | Yes | Yes | Yes | Yes | No | No | Yes | Yes |
Pivot | Yes | Yes | Yes | Yes | Yes | No | No | Yes |
Pivot (Totals) | Yes | Yes | Yes | Yes | Yes | Yes | No | Yes |