Query report data and export to file

Request a file export of data from any report json that is not created

Query report data from a report that is not created

Based on the report type sent in the request, the data structure returned may have multiple formats.

Mode:

  • Export: 100000 Records

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

TypeHeadersIndexRecordsGroup RowsGroup ColumnsTotalsPeriodsTranspose
ListYesNoYesNoNoNoNoNo
List (Totals)YesNoYesNoNoYesNoNo
PeriodListYesYesYesNoNoNoYesYes
SummaryYesYesYesYesNoNoNoYes
Summary (Details)YesYesYesYesNoYesNoNo
Summary (Totals)YesYesYesYesNoYesNoYes
PeriodSummaryYesYesYesYesNoNoYesYes
PivotYesYesYesYesYesNoNoYes
Pivot (Totals)YesYesYesYesYesYesNoYes
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

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

Allowed:
string
enum
required

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

Allowed:
boolean
Defaults to true

Flag to include charts in the export, defaults to True

Body Params
string
required
length between 1 and 100

Report title

property_ids
array of integers
required
length ≥ 1

Report property ids

property_ids*
integer
enum
required

Dataset id

columns
array of objects
required
length ≥ 1

Report columns

columns*
group_rows
array of objects | null
Defaults to null

Report group rows

group_rows
group_columns
array of objects | null
Defaults to null

Report group columns

group_columns
custom_cdfs
array of objects | null
Defaults to null

Report custom cdfs

custom_cdfs
filters
object | null

Report filters

sort
array of objects | null
Defaults to null

Report sort

sort
settings
object | null

Report settings

periods
array of objects | null
Defaults to null

Periods to compare

periods
formats
object | null

Formatting options of the report

comparisons
array of objects | null
Defaults to null

A list of up to 5 Comparisons, each containing 'name' and 'filters' properties. The 'filters' are the same structure as those in report.filters.

comparisons
Headers
integer
required
≥ 1

Property id of the client

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json