Performance Reports

Performance

The link to the endpoint redoc.

The generic endpoint can be used to get performance results on multiple aggregation levels. Specify: the entity-type corresponding to the required aggregation level, array of entity-ids, and the date range parameters to the endpoint to retrieve the aggregated performance metrics for the requested period.

  • The upper limit on the number of entity-ids is 100 for each request.

  • The endpoint supports performance data for the following entity types:

    • CAMPAIGN

    • AD_GROUP

    • AD

    • KEYWORD

    • TARGET_CATEGORY

    • TARGET_PRODUCT

The response contains performance metrics corresponding to each of the requested entity-ids, as well as the aggregated total.

Target pages performance

The link to the endpoint redoc.

The endpoint to get performance results on ad-group level split by target pages. Specify array of ad-group-ids and the date range parameters to the endpoint to retrieve the aggregated performance metrics for the requested period.

  • The upper limit on the number of ad-group-ids is 100 for each request.

  • The endpoint supports the following target page types:

    • SEARCH - search result page

    • CATEGORY - category browsing result page

    • PDP - sponsored products shown on product page

The response contains performance metrics per each requested ad-group-id split by targetPage as well as the aggregated total:

Search terms performance

The link to the endpoint redoc.

The endpoint to get search terms performance results on ad-group level. Specify array of ad-group-ids and the date range parameters to the endpoint to retrieve the aggregated performance metrics for the requested period.

Besides ad-group-ids, pagination parameters can be provided as page and page-size.

  • The upper limit on the number of ad-group-ids is 100 for each request.

  • The upper limit on the page-size is 100 for each request.

The response contains performance metrics per each requested ad-group-id split by searchTerm as well as the aggregated total:

Categories performance

The link to the endpoint redoc.

The endpoint to get categories performance results on ad-group level. Specify array of ad-group-ids and the date range parameters to the endpoint to retrieve the aggregated performance metrics for the requested period.

Besides ad-group-ids, pagination parameters can be provided as page and page-size.

  • The upper limit on the number of ad-group-ids is 100 for each request.

  • The upper limit on the page-size is 100 for each request.

The response contains performance metrics per each requested ad-group-id split by category as well as the aggregated total.

Advertiser performance

The link to the endpoint redoc.

The endpoint to get performance results on advertiser level. Specify the date range parameters to the endpoint to retrieve the aggregated performance metrics for the requested period.

The response contains the aggregated total performance metrics.

Date ranges

The reporting endpoints require you to enter a date range. The period-start-date and period-end-date must be provided in the 'YYYY-MM-DD' format. Both dates are inclusive.

For more information, see the date range example below.

  • Both period-start-date and period-end-date can be set to a value representing today or any date within the last 30 days period.

  • Both period-start-date and period-end-date cannot be in the future.

  • period-start-date must be before or equal to period-end-date.
Example 1. Date range. Today example

If today is 2023-12-31, you should set both period-start-date and period-end-date to the same value of 2023-12-31 to get today performance data.

Example 2. Date range. Yesterday example

If today is 2023-12-31, you should set both period-start-date and period-end-date to the same value of 2023-12-30 to get yesterday’s performance data.

Example 3. Date range. Last 7 days example

If today is 2023-12-31, you should set period-start-date to 2023-12-24 and period-end-date to 2023-12-30 to get last 7 days performance data.