Note: This topic provides an overview of the Reporting API An Index product that provides aggregated reporting data that can be delivered through email, Amazon S3 bucket, or pulled through the API. The Reporting API allows customers to create their own customized reports and schedule their automated delivery.. To go directly to our API documentation, see Getting started with the Reporting API.
You can use the Reporting API to access aggregated reporting on all activity from Index Exchange (Index). You can access a wide variety of reporting fields by using the API to craft custom reports tailored to your specific needs. These reports can then be scheduled and either downloaded directly from the API, delivered via email, or delivered to an Amazon S3 bucket.
The Reporting API provides three key features:
-
Access aggregated data instantly.
-
Create custom reports that are tailored to your data needs.
-
Schedule automated ingestion or delivery of aggregated data.
Note: The Reporting API is currently only available for publishers, buyers, and DSPs.
Use cases
As a publisher The owner of a website or app where advertisements are served., here are some examples of how you can use the Reporting API:
-
Monitoring: Your ad ops team wants to build dashboards to monitor their ad revenue across various dimensions such as site, region, device, and time of day.
-
Optimize and decrease inefficiencies: Your sales team would like to evaluate win rate A percentage, calculated as number of bids won by DSPs divided by the number of bids submitted. across all strategic
deal_ids to better understand how to price inventory. -
Alerting: You want to track specific metrics in order to notify key stakeholders when specific KPIs pass their SLAs or thresholds.
-
Troubleshooting: You want to quickly evaluate why spend dropped over the past month, identify the root cause, and fix the issue.
-
Revenue reporting and billing: Your ad ops team would like to automate the delivery of an earnings report from their SSP Supply-Side Platform (SSP). A software platform used by publishers to automate real-time inventory sales to advertisers through an ad exchange or DSP. Also known as the sell-side. partners to their finance team.
Available fields
You can use the Reporting API to build reports across four common reporting scenarios including: supply, demand, deals, and brand data. For a full list of available fields in the Reporting API,
Delivery methods
You can access your reports in one of the following ways:
-
API: You can download reports directly through the API.
-
Email: You can set up your reports to be delivered to one or more email addresses.
-
Amazon S3 bucket: Amazon Simple Storage Service (S3) is a cloud-based storage service. Amazon S3 users can schedule automated report delivery to your storage instance. For more information about Amazon S3, see Amazon S3.
Note: To set up reports to deliver directly to your S3 bucket, contact your Index Representative.
Using the Reporting API
Here are some tips to help you get started using the Reporting API:
-
Make sure that you are comfortable using RESTful APIs and writing JSON.
-
Refer to the example reports and sample JSON we have created to guide you through using the API.
-
We recommend using a user-friendly tool to access the API, such as Postman.
To start creating your own custom reports, see Getting started with the Reporting API.
