Skip to main content

​
Introduction

This guide provides a consolidated reference to the reporting endpoints, permissions, and data behaviors. It’s designed to operate as a practical guide for understanding how SSP and DSP reporting works, how to align API results with the UI, and how to navigate rate limits, data latency, and reporting discrepancies. You can use it as a companion resource when building or troubleshooting your Retail Media API integrations.
Reporting EndpointsYou can find out more on our reporting endpoints in the following sections:

​
Reporting Suite & Permissions

​
SSP (Retailer permission)

The SSP Reporting suite provides retailer-level analytics to help understand the sources of Retail Media revenue. Access to the following report types requires API consent for a Supply/Retailer account:

​
Revenue Report

Provides retailer-level visibility into monetization revenue and its sources across advertisers, platforms, and sales channels.

​
Fill Rate Report

Shows how much of your inventory is filled with ads across placements, page types, and platforms to help identify opportunities to grow demand and revenue.

​
DSP (Brand/Seller permission)

The DSP Reporting suite provides high-level analytics across Brand or Seller accounts. Access to the following report types requires API consent for a Demand Brand/Seller account. These report types are available at the Account, Campaign, and Line Item levels.

​
Flexible Reporting

Flexible reporting is also available on the DSP and SSP endpoints. Instead of using one of the report types above, omit reportType from the request and use metrics and dimensions to customize the data returned.
See this page for the full list of available metrics and dimensions.
Please omit product-level metrics for Sponsorships and Onsite Display campaigns in flexible reporting. These metric-dimension combinations are not supported for these campaign types and may return incomplete or misleading results.

​
Report Types

Report Type

Campaign Type

Description

summary

Sponsored Products, Onsite Display (Preferred Deals)

Daily metrics aggregated for any single campaign or line item

capout

Sponsored Products only

The sponsored product capout report provides details about when campaigns are running out of budget too soon, and enables advertisers to make the decision.

attributedTransactions

Sponsored Products, Onsite Display (Preferred Deals)

Hourly logs of each transaction attributable to an impression or a click; includes advanced dimensions such as the specific attribution rule used to match the impression or click to a sale

pageType

Sponsored Products, Onsite Display (Preferred Deals)

Daily metrics segmented by the type of retailer web page an ad creative rendered on, such as home page, browse pages, search pages, product detail pages, checkout pages etc.

keyword

Sponsored Products, Onsite Display (Preferred Deals)

Daily metrics segmented by the keyword or phrase used to land on the search page where an ad creative rendered; non-search pages are not associated with keywords.

  • Note*: sometimes you may see misalignment between keyword reporting and the Criteo UI due to filtering logic required to run the platform smoothly. However exports from the Criteo UI do not rely on this filtering and should match API data

productCategory

Sponsored Products only

Daily metrics segmented by the category of product advertised in the ad creative; categories are standardized across brands and retailers, which may differ from retailer-specific categories

product

Sponsored Products only

Daily metrics segmented by the product being advertised in the ad creative

servedCategory

Sponsored Products, Onsite Display (Preferred Deals)

Daily metrics segmented by the category of the page on which an ad was served; categories are specific to the retailer, which may differ from standardized categories across brands and retailers

environment

Sponsored Products, Onsite Display (Preferred Deals)

Daily metrics segmented by the environment (desktop, mobile, app) in which the ad interaction takes place

  • Keyword reporting can misalign with the UI due to filtering logic used to support platform performance. UI exports do not rely on this logic and align with API data. Only applies to search pages.
  • Categories are standardized across brands and retailers, which may differ from retailer-specific categories.

​
Comparing Sources (API vs UI)

When comparing API reporting to the Criteo platform (UI), consider the following details when aligning settings.

​
API vs UI Default Settings Overview

Field

UI Default

API Default

clickAttributionWindow

SSP Revenue: Onsite 14D

Sponsored Products 30D

DSP report: campaign attribution settings

Campaign attribution settings

viewAttributionWindow

SSP Revenue: Onsite 14D

Sponsored Products 1D

DSP report: campaign attribution settings

Campaign attribution settings

clickMatchLevel

SSP Revenue:sameCategory

DSP report: campaign attribution settings

Campaign attribution settings

viewMatchLevel

SSP Revenue: OnsitesameCategorySponsored ProductssameSku;

DSP report: campaign attribution settings

Campaign attribution settings

timeZone

Account default

UTC

startDate/endDate

Last 7 days

Required

salesChannel

Campaigns Tab: online only;

Analytics Tab: online + offline

Online + offline

​
Attribution

  • set the API viewAttributionWindow + clickAttributionWindow to match the campaign settings
or
  • omit both from the API query and the API will default to campaign settings for both the DSP and SSP reports
or
  • Align to the SSP Revenue report attribution settings above (UI defaults can differ from campaign-level settings).

​
Timezone

  • The UI uses the account timezone. In the API, set timeZone to the account’s IANA timezone.
  • If you omit timeZone, the API defaults to UTC (not the account timezone).

​
Sales Channel / Offline Sales

  • The UI Campaigns tab excludes offline sales; the Analytics tab includes offline sales (and can be filtered).
  • If the API request omits salesChannel, it includes both online + offline sales by default.
  • For parity/completeness, prefer the UI Analytics view.

​
Metrics + Dimensions

  • Ensure both UI and API use the same metrics and breakdowns (dimensions).
  • Use an API reportType or omit it and specify metrics/dimensions directly to match the UI.

​
Data Availability, Retention & Limits

​
Data Availability

Metrics may have several hours of latency and different types of activity and attribution data become available at different times after the event or sale. Maximum delay values are not guaranteed, and the times below reflect the 95th and 50th percentile latency.
Different types of activity and attribution data become available at different times after the event or sale:
  • Onsite activity data is typically available within 6–8 hours of the event.
  • Offsite activity data is typically available within 24 hours of the event.
  • Initial attribution data is available within 7–9 hours of the sale.
  • Final attribution data is processed and posted within 74 hours after the sale.
  • Please note that potential minor updates can occur up to 120 hours before finalization
Please note that data is processed and batched hourly, so same-day data may be partially available.
Please note data may be slightly misaligned for fresher periods because sources vary across reports (SSP API, DSP API, UI Analytics modules). Data should align on finalization.

​
Retention

Reporting data is retained for a rolling 3-year period.

​
Caching Logic

  • Reporting responses may be cached to balance availability and performance.
  • Reports with an end date of today or yesterday are cached for 1 hour.
  • Reports with an end date older than yesterday are cached for 24 hours.
  • The exact cache expiration time is provided in the expiresAt field of the /status response.
  • Reports support a maximum window of 100 days per request for the campaigns and line items endpoints. For the account reporting endpoint, that window is 31 days max.
  • Use bulk calls to pass up to 50 IDs at a time when pulling data across a large number of Campaigns or Line Items. Note that for the account reporting endpoint, that limit is only 5 IDs.
  • Report size is capped at 100k rows
  • Hitting this limit will truncate data and produce incomplete results. Narrow the parameters by requesting fewer Campaigns or Line Items in report filters, shortening the date range, or adjusting the report dimensions until the result set falls within the limit.
  • If you encounter a 429 Too Many Requests error, implement exponential backoff logic to pause and retry requests after a delay, giving the API time to reset the application’s limit before attempting again. More details on rate limits on this page and in the table below.

OAuth Method

Rate limit

Rate limit applies at level

Client Credentials

250 callsper minute for default endpoints

40 callsper minute for reporting endpoints

Application level

Authorization Code

10 callsper minute

Account


​
What’s next