Bulk Performance Reports

These endpoints allow you to fetch performance data for multiple entities in a single request, reducing the need for separate individual requests for each entity.It enhances the efficiency by generating comprehensive reports that encompass a significant timeframe.Using this endpoint, you can effectively minimize the overall expenses associated with generating individual reports for shorter intervals.

The link to the endpoint redoc.

As of 9 July 2024, it is allowed to add new fields for CSV file type reports.This change is made to provide more information without requiring partners to switch to a newer version.For more details, please refer to the Best practices page.These fields can be added to any position, be it start, middle or at the end.
Reports include only entities that had performance during the selected period. As a result, the entities featured in the reports represent a subset of those in the campaign configuration.

Accessing the bulk performance data

Use the endpoints Request a performance report and Retrieve a performance report by report id respectively to first initiate the creation of the performance report and then retrieve it.

To access the performance report follow the steps below:

1. Generating performance report

  1. Specify the start-date and end-date of the reporting period as an input parameter to the Request a performance report endpoint.

  2. The processStatusId will be returned by this endpoint.

2. Retrieving the process status

Use the processStatusId from the response as an input parameter to the Get the status of an asynchronous process by process status id endpoint to retrieve the actual processing status of your request.

Get the status of an asynchronous process by process status id is a Shared API part of V10. Make sure you set your headers accordingly.

3. Retrieving the performance report

To retrieve the performance report:

  1. Specify the report-id received from Get the status of an asynchronous process by process status id endpoint (corresponds to entityId in response) as a URL parameter to the Retrieve a performance report by report id endpoint.

  2. In the response you receive

    • The URL for downloading the requested report.

    • The expiry date and time of the URL.

    • The expiry date and time of the performance report.

  • The download link provided for the performance report has a limited lifespan of 15 minutes. If you wish to access the same report again, it is necessary to request a new URL from Retrieve a performance report by report id endpoint using the same report-id after the initial 15-minute duration has elapsed.

Date ranges

The reporting endpoints require you to enter a date range.

  • start-date is inclusive.

  • end-date is inclusive.

  • The maximum period between start-date and end-date is 35 days.

  • The start-date can be at most 12 months in the past.

For more information, see the date range example below.

Example 1. Date range. Yesterday example

If today is 2024-12-31, start-date should be 2024-12-30 and end-date should be 2024-12-30 to get yesterday’s performance data.

Example 2. Date range. Custom 30 days in the past example

If today is 2024-12-31, you should set start-date to 2024-07-24 and end-date to 2024-08-22 to get a 30-day period in the past.