Reporting
The Reporting API is a modular interface used to configure, customize, and retrieve reports. This API can either retrieve pre-built reports or specify configuration, criteria, and attributes to tailor the data output according to your specific needs. The API provides the capability to execute reports both on an adhoc basis and through scheduled runs.
It includes functionality for checking the real time status of report generation.
Availability
The Reporting API is available in the following regions:
- United States
- Australia
- Canada
- Europe
- United Kingdom
How Reporting API works
The following steps help you to get started with Reporting:
- Request access — follow the steps in getting started to set up access to the Reporting API
- Identify report types — determine the specific types of reports available and relevant to your needs. Learn more about report types
- Set up how and when you want to receive your reports — configure identified reports and setup preferences for how and when you want to receive them. Review available configurations and how to manage a report configuration.
- Run or check report status — execute your report generation or monitor the status of previously requested reports. Learn more about Run your report or check status
- Retrieve generated reports — Access and retrieve the generated reports based on your configured preferences. Learn more about Retrieve your reports
Related
Report types
Report configuration
Pagination
Get report types
Manage report configurations
Run reports
Retrieve reports
Testing reports