Query Report Data

post

https://example.com/reports/{dataset}

Executes the query for the given dataset and returns the matching rows, paged and sorted. Results will be flatten in paged list of dynamic objects that differ per dataset. Filters are also dynamic and may differ per dataset. The representation is selected by the Accept header - JSON, XML, or Excel.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dataset

string

required

The dataset key identifying the report to execute.

Query Params

page

integer

≥ 1

Defaults to 1

The page of data to retrieve.

per_page

integer

1 to 250

Defaults to 10

The number of items per page.

sort_by

string

The field to sort by (a response JSON property name). Optional; when omitted, search results fall back to their own relevance ordering.

sort_order

string

enum

Defaults to Asc

The sort order. Optional; only applies together with sort_by.

Allowed:

Body Params

Filter parameters for this query.

Filter values for querying a report's data. Shape is dynamic since each dataset defines its own filters.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

400There was a problem with the data provided for this request.

401Authorization was denied for this request.

404The requested resource is not found.

415The media type of the request or of the requested representation is not supported.

499The request was closed by the client before the server could respond.

500A server side error occurred.