Create a Custom Report
To begin, click "Try it out" to provide the desired filters, fields, and metrics of your
custom report. These may vary based on report type. Use the "Examples" dropdown to
automatically generate a request with all of the supported filters, fields, and metrics
available with each report type. Before executing a request, you can edit and/or remove
items in the request body.
For a full list of supported filters, fields, and metrics, and their requirement specifications, please refer to the schemas at the bottom of this document.
Requirements
To successfully generate a new report, at least one supported field must be included in
the request body, and the from_date and to_date filters must be specified. Please note:
this API uses the
ISO format for all date and time
entries.
Next Steps
A successful response will return a unique token necessary to obtain your report status and,
upon completion, a download url. Please keep record of the unique token provided in this
response. This token is required to execute the GET request below labeled "Check Report
Status by Token."