# Criteo Retailer Integration Documentation
## Guides
- [Ad Rendering Best Practices](https://developers.criteo.com/retailer-integration/docs/ad-rendering-best-practices.md): This page lists a set of best practices for Ad Rendering at Criteo.
- [Digital Service Act (EU Only)](https://developers.criteo.com/retailer-integration/docs/dsa-eu-only.md): Learn about the Digital Service Act and how it will impact integration. The DSA only applies in the EU.
- [Formats Overview](https://developers.criteo.com/retailer-integration/docs/format-overview.md): This page provides an overview of all the Ad formats available to render Ads in the RM Criteo solution
- [Mobile Deeplinks Guide for Offsite](https://developers.criteo.com/retailer-integration/docs/mobile-deeplinks-guide-for-offsite-app-integrations.md)
- [Branded Header](https://developers.criteo.com/retailer-integration/docs/branded-header.md)
- [Butterfly](https://developers.criteo.com/retailer-integration/docs/butterfly.md)
- [Flagship](https://developers.criteo.com/retailer-integration/docs/flagship.md)
- [Commerce Display](https://developers.criteo.com/retailer-integration/docs/commerce-display-formats.md)
- [Interactive Header](https://developers.criteo.com/retailer-integration/docs/interactive-header.md)
- [Showcase](https://developers.criteo.com/retailer-integration/docs/showcase.md)
- [Digital Shelf Talker](https://developers.criteo.com/retailer-integration/docs/digital-shelf-talker.md): Specifications for the Digital Shelf Talker Ad format
- [Display Panel](https://developers.criteo.com/retailer-integration/docs/display-panel.md)
- [IAB](https://developers.criteo.com/retailer-integration/docs/iab.md): IAB banners are static display units that redirect to a dedicated URL
- [Display Banners](https://developers.criteo.com/retailer-integration/docs/display-banners.md)
- [Branding Display Grid Solo](https://developers.criteo.com/retailer-integration/docs/branding-display-grid-solo.md): This guide provides the specifications and technical details for the Branding Display Grid Solo format rendering.
- [Branding Display Spotlight Solo](https://developers.criteo.com/retailer-integration/docs/branding-display-spotlight-solo.md): This guide provides the specifications and technical details for the Branding Display Spotlight Solo format rendering.
- [Commerce Display Grid Duet](https://developers.criteo.com/retailer-integration/docs/commerce-display-grid-duet.md): This guide provides the specifications and technical details for the Commerce Display Grid Duet format rendering.
- [Commerce Display Grid Shelf](https://developers.criteo.com/retailer-integration/docs/commerce-display-grid-shelf.md): This guide provides the specifications and technical details for the Commerce Display Grid Shelf format rendering.
- [Commerce Display Spotlight](https://developers.criteo.com/retailer-integration/docs/commerce-display-spotlight.md): This guide provides the specifications and technical details for the Commerce Display Spotlight format rendering.
- [Onsite Display (New)](https://developers.criteo.com/retailer-integration/docs/onsite-display-new-formats.md): This page gives an overview of the new Onsite Display Formats and maps the changes with the legacy formats
- [Sponsored Products](https://developers.criteo.com/retailer-integration/docs/sponsored-products.md): This guide provides a response description, attributes and example of rendering for the Sponsored Products ads
- [Branding Video Standout](https://developers.criteo.com/retailer-integration/docs/branding-video-standout.md): Branding Video Standout is a format combining a branded video with a branded image and a CTA.
- [Commerce Video Grid Duet](https://developers.criteo.com/retailer-integration/docs/commerce-video-grid-duet.md): Commerce Video Grid Duet is an in-grid format combining a video file with one or more product SKUs.
- [Commerce Video Spotlight](https://developers.criteo.com/retailer-integration/docs/commerce-video-spotlight.md): Commerce Video Spotlight combines a branded 16:9 video with an interactive product zone that adapts to desktop and mobile layouts.
- [Video Formats](https://developers.criteo.com/retailer-integration/docs/video-formats.md): Overview of the available Criteo Video Ad Formats
- [Ad Tracking Best Practices](https://developers.criteo.com/retailer-integration/docs/ad-tracking-best-practices.md)
- [BeaconSDK](https://developers.criteo.com/retailer-integration/docs/beacon-sdk.md): This guide details the process for automatic beacon tracking on web using our Criteo's BeaconSDK.
- [Beacon Types](https://developers.criteo.com/retailer-integration/docs/beacon-types.md): This page breaks down the different types and levels of Criteo beacons
- [Introduction to Beacons](https://developers.criteo.com/retailer-integration/docs/introduction-to-beacons.md): Tracking interaction events using beacons is the last process to complete your integration with Criteo
- [Legacy & Universal Beacons](https://developers.criteo.com/retailer-integration/docs/legacy-universal-beacons.md): This page outlines Criteo's Legacy and the Universal beacon setups and explains how to migrate from Legacy to Standard/Universal beacons
- [Server-Side Beacons](https://developers.criteo.com/retailer-integration/docs/server-side-beacons.md): This guides covers how to implement server-side beacons.
- [API response structure](https://developers.criteo.com/retailer-integration/docs/api-response-structure.md)
- [Get started with Commerce Onsite Video](https://developers.criteo.com/retailer-integration/docs/commerce-video-integration.md): Get started with the Onsite Video integration process
- [Criteo-Owned Video Player Integration](https://developers.criteo.com/retailer-integration/docs/criteo-owned-video-player-integration.md)
- [Tracking Ad-Related Activity](https://developers.criteo.com/retailer-integration/docs/tracking-ad-related-activity.md)
- [Video Player Implementation (App: Android)](https://developers.criteo.com/retailer-integration/docs/video-player-implementation-app-android.md): This document provides implementation guidance for integrating Onsite Video ads into native Android apps.
- [Video Player Implementation (Web Browser)](https://developers.criteo.com/retailer-integration/docs/video-player-implementation-guide-desktopmobile.md): This page provides implementation guidance for video players in web browsers, relevant for both desktop and mobile browsers.
- [Video Player Implementation (App: iOS)](https://developers.criteo.com/retailer-integration/docs/video-player-implementation-ios-app.md): This document provides implementation guidance for Onsite Video Ads in iOS Apps.
- [Video Player Specifications](https://developers.criteo.com/retailer-integration/docs/video-player-specifications.md)
- [Introduction](https://developers.criteo.com/retailer-integration/docs/introduction-1.md): Sharing your catalog with Criteo is the first step for a succesful integration
- [Product Importer API Guide](https://developers.criteo.com/retailer-integration/docs/product-importer-guide.md)
- [Feed Best Practices](https://developers.criteo.com/retailer-integration/docs/feed-best-practices.md)
- [Product Feed Upload Guide](https://developers.criteo.com/retailer-integration/docs/product-upload-guide.md)
- [Lookup Files](https://developers.criteo.com/retailer-integration/docs/lookup-files.md)
- [Product Feed Examples](https://developers.criteo.com/retailer-integration/docs/product-feed-examples.md)
- [Product Feed Parameters](https://developers.criteo.com/retailer-integration/docs/product-feed-parameters.md)
- [Google Ad Manager (GAM) - Criteo Onsite Display](https://developers.criteo.com/retailer-integration/docs/gam-overview.md)
- [OneTag for Retail Media Offsite](https://developers.criteo.com/retailer-integration/docs/onetag-for-offsite.md)
- [OneTag for Offsite - Hybrid Apps](https://developers.criteo.com/retailer-integration/docs/onetag-offsite-for-hybrid-apps.md): Addendum for Hybrid Apps
- [OneTag for Retail Media Onsite](https://developers.criteo.com/retailer-integration/docs/onetag.md)
- [API calls](https://developers.criteo.com/retailer-integration/docs/api-calls-checklist.md)
- [Branded Header](https://developers.criteo.com/retailer-integration/docs/branded-header-1.md): Here is a breakdown of the requirements for your Branded Header placement to pass both technical and design QA
- [Butterfly](https://developers.criteo.com/retailer-integration/docs/butterfly-1.md): Here is a breakdown of the requirements for your Butterfly placement to pass both technical and design QA
- [Digital Shelf Talker](https://developers.criteo.com/retailer-integration/docs/digital-shelf-talker-1.md): Here is a breakdown of the requirements for your Digital Shelf Talker placement to pass both technical and design QA
- [Display Panel](https://developers.criteo.com/retailer-integration/docs/display-panel-1.md): Here is a breakdown of the requirements for your Display Panel placement to pass both technical and design QA
- [Flagship](https://developers.criteo.com/retailer-integration/docs/flagship-1.md): Here is a breakdown of the requirements for your Flagship placement to pass both technical and design QA
- [IAB](https://developers.criteo.com/retailer-integration/docs/iab-1.md): Here is a breakdown of the requirements for your IAB placement to pass both technical and design QA
- [Checklists per format](https://developers.criteo.com/retailer-integration/docs/qa-checklists.md)
- [Interactive Header](https://developers.criteo.com/retailer-integration/docs/interactive-header-1.md): Here is a breakdown of the requirements for your Interactive Header placement to pass both technical and design QA
- [Showcase](https://developers.criteo.com/retailer-integration/docs/showcase-1.md): Here is a breakdown of the requirements for your Showcase placement to pass both technical and design QA
- [Sponsored Products](https://developers.criteo.com/retailer-integration/docs/sponsored-products-1.md): Here is a breakdown of the requirements for your sponsored product placement to pass both technical and design QA:
- [Ad Server API Calls](https://developers.criteo.com/retailer-integration/docs/api-calls.md): Use Criteo's ad server to get all information needed to render and track ads
- [Basket Page](https://developers.criteo.com/retailer-integration/docs/cart-page.md)
- [Category Flyout](https://developers.criteo.com/retailer-integration/docs/category-flyout.md)
- [Category Pages](https://developers.criteo.com/retailer-integration/docs/category-page.md)
- [Favorites Page](https://developers.criteo.com/retailer-integration/docs/favorites-page.md)
- [Filters](https://developers.criteo.com/retailer-integration/docs/filtering.md)
- [Homepage](https://developers.criteo.com/retailer-integration/docs/homepage.md)
- [API Parameters](https://developers.criteo.com/retailer-integration/docs/api-parameters-1.md): These parameters are valid for all event types and should be included in all ad requests wherever applicable
- [Order Confirmation Page](https://developers.criteo.com/retailer-integration/docs/order-confirmation-page.md)
- [Organic Add-To-Cart Events](https://developers.criteo.com/retailer-integration/docs/organic-add-to-cart-events.md)
- [Product Details Page](https://developers.criteo.com/retailer-integration/docs/product-details-page.md)
- [Search Bar Dropdown](https://developers.criteo.com/retailer-integration/docs/search-bar-dropdown.md)
- [Search Pages](https://developers.criteo.com/retailer-integration/docs/search-page.md)
- [API Responses](https://developers.criteo.com/retailer-integration/docs/api-responses.md)
- [Ad Request Best Practices](https://developers.criteo.com/retailer-integration/docs/requesting-ads-best-practices.md)
- [Authentication Tokens](https://developers.criteo.com/retailer-integration/docs/using-tokens.md)
- [Integration process](https://developers.criteo.com/retailer-integration/docs/integration-process.md): An overview of the integration process using the Direct API method
- [Integration Introduction](https://developers.criteo.com/retailer-integration/docs/overview.md): Learn more about the Criteo Retail Media Ad Delivery System and how to integrate with it
- [Glossary](https://developers.criteo.com/retailer-integration/docs/rm-glossary.md)
- [What's New?](https://developers.criteo.com/retailer-integration/docs/whats-new.md): Welcome to the Changelog for the Retailer Integration Documentation.
## Changelog
- [Welcome to Criteo Retail Media Delivery](https://developers.criteo.com/retailer-integration/changelog/welcome-to-criteo-retail-media-delivery.md)
- [v2022.04 Release Notes](https://developers.criteo.com/retailer-integration/changelog/v202204-release-notes.md)
- [Announcing bulk calls and rate limits](https://developers.criteo.com/retailer-integration/changelog/announcing-bulk-calls-and-rate-limits.md)
- [Version 2021.10 release notes](https://developers.criteo.com/retailer-integration/changelog/version-202107-release-notes.md)
- [Welcome to Criteo Changelog](https://developers.criteo.com/retailer-integration/changelog/retailmedia-changelog.md)
# Criteo Retail Media API Documentation
## Guides
- [API Error Codes](https://developers.criteo.com/retail-media/docs/api-error-codes.md)
- [Troubleshooting Guide](https://developers.criteo.com/retail-media/docs/api-troubleshooting-guide.md)
- [Escalation Guidelines](https://developers.criteo.com/retail-media/docs/escalation-guidelines.md): This page indicates which information to provide if you need to contact Criteo for assistance regarding the Retail Media API
- [Reporting Diagnostic Guide](https://developers.criteo.com/retail-media/docs/reporting-overview-diagnostic-guide.md): 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.
- [Overview](https://developers.criteo.com/retail-media/docs/troubleshooting-overview.md)
- [API Pattern](https://developers.criteo.com/retail-media/docs/api-pattern.md)
- [API Response](https://developers.criteo.com/retail-media/docs/api-response.md)
- [Authentication](https://developers.criteo.com/retail-media/docs/authentication.md)
- [Bulk Calls](https://developers.criteo.com/retail-media/docs/bulk-calls.md): This page describes how to perform bulk calls towards Criteo Retail Media API
- [Campaign, Line Item & Product Statuses](https://developers.criteo.com/retail-media/docs/campaign-lineitem-status.md): Overview of the campaign, line item, and products statuses work with the API
- [Campaign Structure](https://developers.criteo.com/retail-media/docs/campaign-structure.md)
- [Rate Limits](https://developers.criteo.com/retail-media/docs/rate-limits.md): This page describes the Criteo API rate limit policy, and provides some best practices to help manage rate limits
- [Authorization Requests](https://developers.criteo.com/retail-media/docs/authorization-requests.md)
- [Consent URL Generation](https://developers.criteo.com/retail-media/docs/consent-url-generation.md)
- [API Authorization](https://developers.criteo.com/retail-media/docs/api-authorization.md)
- [Create Your API Application](https://developers.criteo.com/retail-media/docs/create-your-app.md)
- [Create Your Organization](https://developers.criteo.com/retail-media/docs/create-your-organization.md)
- [Create Your Partner Account](https://developers.criteo.com/retail-media/docs/create-your-partner-account.md)
- [Manage Your Account, Organization and Apps](https://developers.criteo.com/retail-media/docs/developer-accounts-organizations-apps.md): This section provides guidance on managing your Developer Account, Organization, and Apps once created.
- [Get Your Credentials](https://developers.criteo.com/retail-media/docs/get-credentials.md)
- [Get connected to the API](https://developers.criteo.com/retail-media/docs/connect-to-the-api.md)
- [OAuth App Implementation](https://developers.criteo.com/retail-media/docs/oauth-app-implementation.md)
- [OAuth App – Authorization Code & PKCE Setup](https://developers.criteo.com/retail-media/docs/oauth-app-authorization-code-pkce-setup.md): This guide provides step-by-step instructions for implementing OAuth 2.0 Authorization Code with PKCE, including authorization requests and token exchange.
- [OAuth App - Authorization Code Setup](https://developers.criteo.com/retail-media/docs/oauth-app-authorization-code.md): This guide provides step-by-step instructions on setting up an API application using the authorization code workflow
- [OAuth App - Client Credentials Setup](https://developers.criteo.com/retail-media/docs/oauth-app-client-credentials.md): This guide provides step-by-step instructions on setting up an API application using the client credentials workflow
- [Account Creation and Management (Private Market)](https://developers.criteo.com/retail-media/docs/account-creation-and-management-private-market.md)
- [Account Fees (Private Market)](https://developers.criteo.com/retail-media/docs/account-fees.md)
- [Accounts Endpoints](https://developers.criteo.com/retail-media/docs/accounts-endpoints.md)
- [Brands](https://developers.criteo.com/retail-media/docs/brands.md)
- [Account](https://developers.criteo.com/retail-media/docs/account.md)
- [Retailer Search](https://developers.criteo.com/retail-media/docs/retailer-search.md)
- [Sellers](https://developers.criteo.com/retail-media/docs/sellers.md)
- [Account Level Report](https://developers.criteo.com/retail-media/docs/account-level-report.md)
- [DSP Analytics Endpoints](https://developers.criteo.com/retail-media/docs/demand-side-analytics-get-started.md): Setup your endpoints, view report attributes, and examples of requests
- [Overview](https://developers.criteo.com/retail-media/docs/demand-side-analytics-overview.md)
- [Demand Side Analytics (DSP)](https://developers.criteo.com/retail-media/docs/analytics.md)
- [Metrics and Dimensions (DSP)](https://developers.criteo.com/retail-media/docs/metrics-and-dimensions.md)
- [Report Types](https://developers.criteo.com/retail-media/docs/report-types.md): A list of all available report types
- [Algebra Nodes](https://developers.criteo.com/retail-media/docs/algebra-nodes.md)
- [Audience Endpoints](https://developers.criteo.com/retail-media/docs/audience-endpoints.md)
- [Audience Segment Endpoints](https://developers.criteo.com/retail-media/docs/audience-segment-endpoints.md)
- [Audiences](https://developers.criteo.com/retail-media/docs/audiences.md)
- [Balances Endpoints](https://developers.criteo.com/retail-media/docs/balances-endpoints.md): View and manage all available balances across campaigns
- [Balances](https://developers.criteo.com/retail-media/docs/balances.md)
- [Billing](https://developers.criteo.com/retail-media/docs/billing.md)
- [Partner Billing Report](https://developers.criteo.com/retail-media/docs/partner-billing-report.md)
- [PBR Metrics](https://developers.criteo.com/retail-media/docs/pbr-metrics.md)
- [Campaigns Endpoints](https://developers.criteo.com/retail-media/docs/campaigns-endpoints.md): View and manage all your campaigns
- [Campaigns](https://developers.criteo.com/retail-media/docs/campaign.md): This page is an overview of how to get started with Campaigns
- [Catalog Endpoints](https://developers.criteo.com/retail-media/docs/catalog-endpoints.md): Generate and download a copy of retailer's inventory
- [Catalog](https://developers.criteo.com/retail-media/docs/catalogs.md)
- [Category Search](https://developers.criteo.com/retail-media/docs/category-search.md)
- [Line Items](https://developers.criteo.com/retail-media/docs/line-items.md)
- [Line Items Endpoints](https://developers.criteo.com/retail-media/docs/line-items-endpoints.md)
- [Bid Multipliers](https://developers.criteo.com/retail-media/docs/bid-multipliers.md)
- [Budget Overrides](https://developers.criteo.com/retail-media/docs/budget-overrides.md): This feature provides more flexibility that allow advertisers to override a line-item budget for specific days or months.
- [Onsite Sponsored Products](https://developers.criteo.com/retail-media/docs/onsite-sponsored-products.md)
- [Keyword Review](https://developers.criteo.com/retail-media/docs/keyword-review.md)
- [Keywords](https://developers.criteo.com/retail-media/docs/keywords.md)
- [Minimum Bid](https://developers.criteo.com/retail-media/docs/minimum-bid.md)
- [Onsite Sponsored Products Line Items](https://developers.criteo.com/retail-media/docs/onsite-sponsored-products-line-items.md)
- [Promoted Products](https://developers.criteo.com/retail-media/docs/promoted-products.md)
- [Recommended Categories](https://developers.criteo.com/retail-media/docs/recommended-categories.md)
- [Recommended Keywords](https://developers.criteo.com/retail-media/docs/recommended-keywords.md)
- [Retailer Budgets](https://developers.criteo.com/retail-media/docs/retailer-budgets.md)
- [Fill Rate Report](https://developers.criteo.com/retail-media/docs/fill-rate-report.md)
- [Supply Side Analytics (SSP)](https://developers.criteo.com/retail-media/docs/supply-side-reporting-ssp.md)
- [Metrics and Dimensions (SSP)](https://developers.criteo.com/retail-media/docs/metrics-and-dimensions-ssp.md)
- [Metrics & Dimensions (Fill Rate Report)](https://developers.criteo.com/retail-media/docs/metrics-dimensions-fill-rate-report.md)
- [Revenue Report](https://developers.criteo.com/retail-media/docs/revenue-report-ssp.md): Supply Side Revenue Report (v2)
- [Criteo API Terms and Conditions](https://developers.criteo.com/retail-media/docs/criteo-api-terms-and-conditions.md): Version 2.0, March 2025
- [Is Criteo Retail Media API for you?](https://developers.criteo.com/retail-media/docs/is-criteo-api-for-you.md)
- [Versioning Policy](https://developers.criteo.com/retail-media/docs/versioning-policy.md)
- [Welcome to Criteo Retail Media API](https://developers.criteo.com/retail-media/docs/welcome-to-criteo.md)
- [API Client Libraries](https://developers.criteo.com/retail-media/docs/api-client-libraries.md)
- [Criteo API Swagger](https://developers.criteo.com/retail-media/docs/criteo-api-swagger.md)
- [Postman Collection](https://developers.criteo.com/retail-media/docs/postman-collection.md)
## API Reference
- [/oauth2/token](https://developers.criteo.com/retail-media/reference/gettoken.md): Creates a token when the supplied client credentials or single use authorization code are valid
- [/2026-01/retail-media/accounts/fees/search](https://developers.criteo.com/retail-media/reference/accountfeessearch.md): Get fees for provided accounts
- [/2026-01/retail-media/account-management/accounts/{accountId}/brands/add](https://developers.criteo.com/retail-media/reference/addbrands.md): Add brands to an account
- [/2026-01/retail-media/account-management/accounts/{accountId}/create-brand-account](https://developers.criteo.com/retail-media/reference/createprivatemarketdemandbrandaccount.md): Creates a new child Demand Brand account for the provided parent Private Market account
- [/2026-01/retail-media/account-management/accounts/{accountId}/create-seller-account](https://developers.criteo.com/retail-media/reference/createprivatemarketdemandselleraccount.md): Creates a new child Demand Seller account for the provided parent Private Market account
- [/2026-01/retail-media/accounts](https://developers.criteo.com/retail-media/reference/getaccounts.md): Gets page of account objects that the current user can access
- [/2026-01/retail-media/account-management/accounts/{accountId}/private-market-child-accounts](https://developers.criteo.com/retail-media/reference/getprivatemarketchildaccountsbyaccountid.md): Gets Private Market child accounts that are associated with the given account
- [/2026-01/retail-media/accounts/{accountId}/grant-consent](https://developers.criteo.com/retail-media/reference/grantconsent.md): Grant consent to a business application on behalf of a Private Market demand account
- [/2026-01/retail-media/account-management/accounts/{accountId}/brands/remove](https://developers.criteo.com/retail-media/reference/removebrands.md): Remove brands from an account
- [/2026-01/retail-media/accounts/sellers/search](https://developers.criteo.com/retail-media/reference/searchsellers.md): Get the sellers mapped to provided accounts
- [/2026-01/retail-media/accounts/fees/update](https://developers.criteo.com/retail-media/reference/updateaccountfees.md): Set fees for provided accounts
- [/2026-01/retail-media/account-management/accounts/{accountId}/sellers](https://developers.criteo.com/retail-media/reference/updatesellers.md): Replace the sellers associated with an account
- [/2026-01/retail-media/reports/accounts](https://developers.criteo.com/retail-media/reference/generateasyncaccountsreport.md): Returns an asynchronous Accounts Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/campaigns](https://developers.criteo.com/retail-media/reference/generateasynccampaignsreport.md): Return an asynchronous Campaigns Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/fillrate](https://developers.criteo.com/retail-media/reference/generateasyncfillratereport.md): Returns an asynchronous Fill Rate Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/line-items](https://developers.criteo.com/retail-media/reference/generateasynclineitemsreport.md): Returns an asynchronous Line Items Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/revenue](https://developers.criteo.com/retail-media/reference/generateasyncrevenuereport.md): Returns an asynchronous Revenue Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/unfilled-placements](https://developers.criteo.com/retail-media/reference/generateasyncunfilledplacementsreport.md): Returns an asynchronous Unfilled Placements Report
This endpoint is subject to specific rate limits.
- [/2026-01/retail-media/reports/{reportId}/output](https://developers.criteo.com/retail-media/reference/getasyncexportoutput.md): Returns the output of an async report
- [/2026-01/retail-media/reports/{reportId}/status](https://developers.criteo.com/retail-media/reference/getasyncexportstatus.md): Returns the status of an async report
- [/2026-01/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove](https://developers.criteo.com/retail-media/reference/addremovecontactlistbyaudiencesegment.md): Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment id.
- [/2026-01/retail-media/accounts/{account-id}/audience-segments/create](https://developers.criteo.com/retail-media/reference/bulkcreateaudiencesegments.md): Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned.
- [/2026-01/retail-media/accounts/{account-id}/audience-segments/delete](https://developers.criteo.com/retail-media/reference/bulkdeleteaudiencesegments.md): Delete the segments associated to the given IDs.
- [/2026-01/retail-media/accounts/{account-id}/audience-segments](https://developers.criteo.com/retail-media/reference/bulkupdateaudiencesegments.md): Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned.
- [/2026-01/retail-media/audience-segments/{audience-segment-id}/contact-list/clear](https://developers.criteo.com/retail-media/reference/clearcontactlistbyaudiencesegment.md): Delete all identifiers from a retail-media contact list audience-segment, with external audience segment id.
- [/2026-01/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list](https://developers.criteo.com/retail-media/reference/getaudiencesegmentcontactliststatistics.md): Returns the statistics of a contact list segment.
- [/2026-01/retail-media/accounts/{account-id}/audiences/search](https://developers.criteo.com/retail-media/reference/searchaudiences.md): Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.
- [/2026-01/retail-media/accounts/{account-id}/audience-segments/search](https://developers.criteo.com/retail-media/reference/searchaudiencesegments.md): Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.
- [/2026-01/retail-media/accounts/{account-id}/balances/{balance-id}/add-funds](https://developers.criteo.com/retail-media/reference/addfundsbyaccountandbalanceid.md): Add funds to a balance for the given account id
- [/2026-01/retail-media/accounts/{account-id}/balances/{balance-id}/change-dates](https://developers.criteo.com/retail-media/reference/changedatesbyaccountandbalanceid.md): Change dates of a balance for the given account id
- [/2026-01/retail-media/accounts/{account-id}/balances](https://developers.criteo.com/retail-media/reference/createbalancebyaccountid.md): Create balance for the given account id
- [/2026-01/retail-media/accounts/{account-id}/balances/{balance-id}](https://developers.criteo.com/retail-media/reference/getbalancebyaccountandbalanceid.md): Get a balance for the given account id and balance id
- [/2026-01/retail-media/balances/{balanceId}/history](https://developers.criteo.com/retail-media/reference/getbalancehistory.md): Gets the balance's historical change data.
- [/2026-01/retail-media/accounts/{account-id}/balances](https://developers.criteo.com/retail-media/reference/getbalancesbyaccountid.md): Gets page of balance objects for the given account id
- [/2026-01/retail-media/balances/{balance-id}/campaigns](https://developers.criteo.com/retail-media/reference/getcampaignsbybalanceid.md): Gets page of campaigns for the given balanceId
- [/2026-01/retail-media/accounts/{account-id}/balances/{balance-id}](https://developers.criteo.com/retail-media/reference/modifybalancebyaccountandbalanceid.md): Modify a balance for the given account id
- [/2026-01/retail-media/billing/partner-report](https://developers.criteo.com/retail-media/reference/createpartnerbillingreportrequestv1.md): Create a Partner Billing Report request.
- [/2026-01/retail-media/billing/partner-report/{requestId}/output](https://developers.criteo.com/retail-media/reference/getpartnerbillingreportoutputv1.md): Get the output of an existing Partner Billing Report.
- [/2026-01/retail-media/billing/partner-report/{requestId}/status](https://developers.criteo.com/retail-media/reference/getpartnerbillingreportstatusv1.md): Get the status of an existing Partner Billing Report.
- [/2026-01/retail-media/line-items/{id}/keywords/add-remove](https://developers.criteo.com/retail-media/reference/addremovekeywords.md): Add or Remove keywords from the line item in bulk
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append](https://developers.criteo.com/retail-media/reference/appendaddtobaskettargetsbylineitemid.md): This endpoint appends one or more add to basket ids to targeting on the specified line item. The resulting state of the add to basket target is returned.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append](https://developers.criteo.com/retail-media/reference/appendaudiencetargetsbylineitemid.md): This endpoint appends one or more audiences ids to targeting on the specified line item. The resulting state of the audience target is returned.
- [/2026-01/retail-media/balances/{balance-id}/campaigns/append](https://developers.criteo.com/retail-media/reference/appendcampaignsbybalanceid.md): appends one or more campaigns to the specified balance
- [/2026-01/retail-media/line-items/{line-item-id}/products/append](https://developers.criteo.com/retail-media/reference/appendpromotedproducts.md): Append a collection of promoted products to a line item
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append](https://developers.criteo.com/retail-media/reference/appendstoretargetsbylineitemid.md): This endpoint appends one or more store ids to targeting on the specified line item. The resulting state of the store target is returned.
- [/2026-01/retail-media/accounts/{accountId}/catalogs/sellers](https://developers.criteo.com/retail-media/reference/catalog_postapiexternalv1accountcatalogssellersbyaccountid.md): Create a request for a Catalog available to the indicated account.
- [/2026-01/retail-media/accounts/{accountId}/catalogs](https://developers.criteo.com/retail-media/reference/catalogapi_postapiv1externalaccountcatalogsbyaccountid.md): Create a request for a Catalog available to the indicated account.
- [/2026-01/retail-media/categories](https://developers.criteo.com/retail-media/reference/categorysearch_getapiexternalv1categories.md): Endpoint to search categories by text and retailer.
- [/2026-01/retail-media/assets](https://developers.criteo.com/retail-media/reference/createasset.md): Creates an asset
- [/2026-01/retail-media/campaigns/{campaignId}/auction-line-items](https://developers.criteo.com/retail-media/reference/createauctionlineitem.md): Creates new auction line item with the specified settings
- [/2026-01/retail-media/accounts/{accountId}/brand-catalog-export](https://developers.criteo.com/retail-media/reference/createbrandcatalogexport.md): Create a request for a Catalog available to the indicated account.
- [/2026-01/retail-media/accounts/{account-id}/campaigns](https://developers.criteo.com/retail-media/reference/createcampaignsbyaccountid.md): Creates a new campaign with the specified settings
- [/2026-01/retail-media/accounts/{account-id}/creatives](https://developers.criteo.com/retail-media/reference/createcreative.md): Create a creative for an account
- [/2026-01/retail-media/campaigns/{campaign-id}/preferred-line-items](https://developers.criteo.com/retail-media/reference/createpreferredlineitembycampaignid.md): Creates a new preferred line item with the specified settings
- [/2026-01/retail-media/accounts/{accountId}/seller-catalog-export](https://developers.criteo.com/retail-media/reference/createsellercatalogexport.md): Create a request for a Catalog available to the indicated account.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete](https://developers.criteo.com/retail-media/reference/deleteaddtobaskettargetsbylineitemid.md): This endpoint removes one or more add to basket ids from targeting on the specified line item. The resulting state of the add to basket target is returned.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete](https://developers.criteo.com/retail-media/reference/deleteaudiencetargetsbylineitemid.md): This endpoint removes one or more audiences ids from targeting on the specified line item. The resulting state of the audience target is returned.
- [/2026-01/retail-media/balances/{balance-id}/campaigns/delete](https://developers.criteo.com/retail-media/reference/deletecampaignsbybalanceid.md): Removes one or more campaigns on the specified balance
- [/2026-01/retail-media/line-items/{line-item-id}/products/delete](https://developers.criteo.com/retail-media/reference/deletepromotedproducts.md): Remove a collection of promoted products from a line item
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete](https://developers.criteo.com/retail-media/reference/deletestoretargetbylineitemid.md): This endpoint removes one or more store ids from targeting on the specified line item. The resulting state of the store target is returned.
- [/2026-01/retail-media/line-items/{id}/keywords](https://developers.criteo.com/retail-media/reference/fetchkeywords.md): Fetch keywords associated with the specified line item
- [/2026-01/retail-media/line-items/{line-item-id}/products](https://developers.criteo.com/retail-media/reference/fetchpromotedproducts.md): Retrieve a page of promoted products for a line item
- [/2026-01/retail-media/accounts/{account-id}/creatives](https://developers.criteo.com/retail-media/reference/getaccountcreatives.md): Get account creatives
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket](https://developers.criteo.com/retail-media/reference/getaddtobaskettargetsbylineitemid.md): This endpoint gets the add to basket target on the specified line item.
- [/2026-01/retail-media/auction-line-items/{lineItemId}](https://developers.criteo.com/retail-media/reference/getauctionlineitem.md): Gets a sponsored product line item by its id.
- [/2026-01/retail-media/campaigns/{campaignId}/auction-line-items](https://developers.criteo.com/retail-media/reference/getauctionlineitemsbycampaign.md): Gets a page of sponsored product line items by campaign id.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences](https://developers.criteo.com/retail-media/reference/getaudiencetargetsbylineitemid.md): This endpoint gets the audience target on the specified line item.
- [/2026-01/retail-media/line-items/{line-item-id}/bid-multipliers](https://developers.criteo.com/retail-media/reference/getbidmultipliersbylineitemid.md): Fetch all bid multipliers for a given line item
- [/2026-01/retail-media/accounts/{accountId}/brands](https://developers.criteo.com/retail-media/reference/getbrandsbyaccountid.md): Gets page of retailer objects that are associated with the given account
- [/2026-01/retail-media/campaigns/{campaignId}/campaign-budget-overrides](https://developers.criteo.com/retail-media/reference/getcampaignbudgetoverrides.md): Get current campaign budget overrides by given campaign id.
- [/2026-01/retail-media/campaigns/{campaignId}](https://developers.criteo.com/retail-media/reference/getcampaignbycampaignid.md): Gets the campaign for the given campaign id
- [/2026-01/retail-media/accounts/{account-id}/campaigns](https://developers.criteo.com/retail-media/reference/getcampaignsbyaccountid.md): Gets page of campaign objects for the given account id
- [/2026-01/retail-media/catalogs/{catalogId}/output](https://developers.criteo.com/retail-media/reference/getcatalogoutput.md): Output the indicated catalog. Catalogs are only available for retrieval when their associated status request
is at a Success status.
Produces application/x-json-stream CatalogProduct json objects (first introduced in the 2021-07 version).
- [/2026-01/retail-media/catalogs/{catalogId}/status](https://developers.criteo.com/retail-media/reference/getcatalogstatus.md): Check the status of a catalog request.
- [/2026-01/retail-media/categories/{categoryId}](https://developers.criteo.com/retail-media/reference/getcategory.md): Endpoint to search for a specific category by categoryId.
- [/2026-01/retail-media/retailers/{retailerId}/cpc-min-bids](https://developers.criteo.com/retail-media/reference/getcpcminbidsbyskuidsv1.md): Get overall and individual minimum bid amount for given retailer id and sku id list.
- [/2026-01/retail-media/accounts/{account-id}/creatives/{creative-id}](https://developers.criteo.com/retail-media/reference/getcreative.md): Get the specified creative
- [/2026-01/retail-media/retailers/{retailer-id}/templates/{template-id}](https://developers.criteo.com/retail-media/reference/getcreativetemplate.md): Gets the template for the specified retailer id and template id
- [/2026-01/retail-media/accounts/{account-id}/keywords/in-review-report](https://developers.criteo.com/retail-media/reference/getkeywordinreviewreport.md): Generate a list of reports for line items which contain one or more actionable keyword reviews
- [/2026-01/retail-media/line-items/{lineItemId}/line-item-budget-overrides](https://developers.criteo.com/retail-media/reference/getlineitembudgetoverrides.md): Gets a collection of monthly and daily budget overrides for the provided line item.
- [/2026-01/retail-media/accounts/{account-id}/line-items](https://developers.criteo.com/retail-media/reference/getlineitemsbyaccountid.md): Gets page of line item objects for the given account id
- [/2026-01/retail-media/line-items/{line-item-id}](https://developers.criteo.com/retail-media/reference/getlineitemsbycampaignid.md): Gets the line item for the given line item id
- [/2026-01/retail-media/campaigns/{campaign-id}/preferred-line-items](https://developers.criteo.com/retail-media/reference/getpreferredlineitemsbycampaignid.md): Gets page of preferred line item objects for the given campaign id
- [/2026-01/retail-media/preferred-line-items/{line-item-id}](https://developers.criteo.com/retail-media/reference/getpreferredlineitemsbylineitemid.md): Gets the preferred line item for the given line item id
- [/2026-01/retail-media/retailers/{retailerId}/recommend-categories](https://developers.criteo.com/retail-media/reference/getrecommendedcategories.md): Endpoint to get recommended categories by given retailer id and sku id list.
- [/2026-01/retail-media/line-items/{externalLineItemId}/keywords/recommended](https://developers.criteo.com/retail-media/reference/getrecommendedkeywords.md): Retrieves a collection of recommended keywords for a line item
- [/2026-01/retail-media/retailers/{retailer-id}/templates](https://developers.criteo.com/retail-media/reference/getretailercreativetemplates.md): Get retailer creative templates
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores](https://developers.criteo.com/retail-media/reference/getstoretargetsbylineitemid.md): This endpoint gets the store target on the specified line item.
- [/2026-01/retail-media/line-items/{line-item-id}/products/pause](https://developers.criteo.com/retail-media/reference/pausepromotedproducts.md): Pause a collection of promoted products associated with a line item
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket](https://developers.criteo.com/retail-media/reference/putaddtobaskettargetbylineitemid.md): This endpoint sets the scope of the add to basket target on the specified line item.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/audiences](https://developers.criteo.com/retail-media/reference/putaudiencetargetsbylineitemid.md): This endpoint sets the scope of the audience target on the specified line item.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}/targeting/stores](https://developers.criteo.com/retail-media/reference/putstoretargetbylineitemid.md): This endpoint sets the scope of the store target on the specified line item.
- [/2026-01/retail-media/retailers/{retailerId}/recommend-keywords](https://developers.criteo.com/retail-media/reference/recommendedkeywords.md): Recommend keywords by given retailer id and sku ids.
- [/2026-01/retail-media/retailers/{retailerId}/pages](https://developers.criteo.com/retail-media/reference/retailerapi_getapi202110externalretailerpagesbyretailerid.md): Get the page types available for the given retailer
- [/2026-01/retail-media/accounts/{account-id}/creatives/search](https://developers.criteo.com/retail-media/reference/searchaccountcreatives.md): Get account creatives
- [/2026-01/retail-media/accounts/{accountId}/retailers/search](https://developers.criteo.com/retail-media/reference/searchaccountretailers.md): Searches for retailers associated with the specified account based on provided search criteria
- [/2026-01/retail-media/brands/search](https://developers.criteo.com/retail-media/reference/searchbrands.md): Search for brands given a retailer ID and search term.
- [/2026-01/retail-media/retailers/{retailerId}/categories/search](https://developers.criteo.com/retail-media/reference/searchcategory.md): Search a retailer categories by given text substring and category ids.
- [/2026-01/retail-media/line-items/{id}/keywords/set-bid](https://developers.criteo.com/retail-media/reference/setkeywordbids.md): Set bid overrides for associated keywords to the given line item in bulk
- [/2026-01/retail-media/line-items/{line-item-id}/products/unpause](https://developers.criteo.com/retail-media/reference/unpausepromotedproducts.md): Un-pause a collection of promoted products associated with a line item
- [/2026-01/retail-media/auction-line-items/{lineItemId}](https://developers.criteo.com/retail-media/reference/updateauctionlineitem.md): Updates a Sponsored Products Line Item given a line item id and a request.
- [/2026-01/retail-media/line-items/{line-item-id}/bid-multipliers](https://developers.criteo.com/retail-media/reference/updatebidmultipliersbylineitemid.md): Updates the bid multipliers for a given line item
- [/2026-01/retail-media/campaigns/{campaignId}/campaign-budget-overrides](https://developers.criteo.com/retail-media/reference/updatecampaignbudgetoverrides.md): Update campaign budget overrides by given campaign id and new campaign budget overrides settings.
- [/2026-01/retail-media/campaigns/{campaignId}](https://developers.criteo.com/retail-media/reference/updatecampaignbycampaignid.md): Updates the campaign for the given campaign id
- [/2026-01/retail-media/accounts/{account-id}/creatives/{creative-id}](https://developers.criteo.com/retail-media/reference/updatecreative.md): Update a creative
- [/2026-01/retail-media/line-items/{line-item-id}/keywords/review](https://developers.criteo.com/retail-media/reference/updatekeywordreviews.md): Update the status of keyword reviews under a line item
- [/2026-01/retail-media/line-items/{lineItemId}/line-item-budget-overrides](https://developers.criteo.com/retail-media/reference/updatelineitembudgetoverrides.md): Update line item budget overrides by given external line item id and new line item budget overrides settings.
- [/2026-01/retail-media/preferred-line-items/{line-item-id}](https://developers.criteo.com/retail-media/reference/updatepreferredlineitembylineitemid.md): Updates the preferred line item for the given line item id
- [/2026-01/retail-media/me](https://developers.criteo.com/retail-media/reference/getcurrentapplication.md): Get information about the currently logged application
## Changelog
- [API Release Schedule & Versioning Policy Update](https://developers.criteo.com/retail-media/changelog/api-release-schedule-versioning-policy-update.md)
- [Version 2026.01 Release Notes](https://developers.criteo.com/retail-media/changelog/version-202601-release-notes.md)
- [Version 2025.10 Release Notes](https://developers.criteo.com/retail-media/changelog/version-202510-release-notes.md)
- [Version 2025.07 Release Notes](https://developers.criteo.com/retail-media/changelog/version-202507-release-notes.md)
- [Version 2025.04 Release Notes](https://developers.criteo.com/retail-media/changelog/version-202504-release-notes.md)
# Criteo Marketing Solutions API Documentation
## Guides
- [API Error Types](https://developers.criteo.com/marketing-solutions/docs/api-error-types.md)
- [Consent URL Generation](https://developers.criteo.com/marketing-solutions/docs/consent-url-generation.md)
- [Developer Accounts](https://developers.criteo.com/marketing-solutions/docs/developer-accounts.md)
- [Managing My App](https://developers.criteo.com/marketing-solutions/docs/managing-my-app.md)
- [Managing My Developer Account](https://developers.criteo.com/marketing-solutions/docs/managing-my-developer-account.md)
- [Managing My Organization](https://developers.criteo.com/marketing-solutions/docs/managing-my-organization.md)
- [Authorization Code Setup](https://developers.criteo.com/marketing-solutions/docs/authorization-code-setup.md)
- [Client Credentials Setup](https://developers.criteo.com/marketing-solutions/docs/client-credentials-setup.md)
- [OAuth Implementation](https://developers.criteo.com/marketing-solutions/docs/oauth-implementation.md)
- [Partial Success for Bulk Operations](https://developers.criteo.com/marketing-solutions/docs/partial-success-for-bulk-operations.md)
- [Rate Limits](https://developers.criteo.com/marketing-solutions/docs/rate-limits.md)
- [Criteo API Terms and Conditions](https://developers.criteo.com/marketing-solutions/docs/criteo-api-terms-and-conditions.md): Version 2.0, March 2025
- [Developer Support](https://developers.criteo.com/marketing-solutions/docs/developer-support.md)
- [Commerce Growth vs. Criteo API](https://developers.criteo.com/marketing-solutions/docs/commerce-growth-vs-criteo-api.md)
- [Is Criteo API for you?](https://developers.criteo.com/marketing-solutions/docs/is-criteo-api-for-you.md)
- [Use Cases](https://developers.criteo.com/marketing-solutions/docs/use-cases.md)
- [Create Your API Application](https://developers.criteo.com/marketing-solutions/docs/create-your-app.md)
- [Create Your Partner Account](https://developers.criteo.com/marketing-solutions/docs/create-your-developer-account.md)
- [Create Your Organization](https://developers.criteo.com/marketing-solutions/docs/create-your-organization.md)
- [Get Your Credentials](https://developers.criteo.com/marketing-solutions/docs/get-api-credentials.md)
- [Onboarding Checklist](https://developers.criteo.com/marketing-solutions/docs/onboarding-checklist.md)
- [Send an Authorization Request to Your Users](https://developers.criteo.com/marketing-solutions/docs/send-an-authorization-request-to-your-users.md)
- [Start Using Your API Connection](https://developers.criteo.com/marketing-solutions/docs/start-using-your-api-connection.md)
- [Versioning Policy](https://developers.criteo.com/marketing-solutions/docs/versioning-policy.md)
- [Welcome to Criteo](https://developers.criteo.com/marketing-solutions/docs/welcome-to-criteo.md)
- [Get Advertiser Portfolio](https://developers.criteo.com/marketing-solutions/docs/get-advertiser-portfolio.md)
- [Advertisers](https://developers.criteo.com/marketing-solutions/docs/advertisers.md)
- [Campaign Statistics](https://developers.criteo.com/marketing-solutions/docs/campaign-statistics.md)
- [Analytics](https://developers.criteo.com/marketing-solutions/docs/analytics.md)
- [Log-Level](https://developers.criteo.com/marketing-solutions/docs/log-level.md)
- [Placement Category](https://developers.criteo.com/marketing-solutions/docs/placement-category.md)
- [Placement](https://developers.criteo.com/marketing-solutions/docs/placement.md)
- [Transaction IDs](https://developers.criteo.com/marketing-solutions/docs/transaction-ids.md)
- [Algebra Nodes](https://developers.criteo.com/marketing-solutions/docs/algebra-nodes.md)
- [Audience Segments](https://developers.criteo.com/marketing-solutions/docs/audience-segments.md)
- [Audience](https://developers.criteo.com/marketing-solutions/docs/audience.md)
- [Audiences](https://developers.criteo.com/marketing-solutions/docs/audiences.md)
- [Authentication](https://developers.criteo.com/marketing-solutions/docs/authentication.md)
- [Ad Set](https://developers.criteo.com/marketing-solutions/docs/ad-set.md)
- [Campaign](https://developers.criteo.com/marketing-solutions/docs/campaign.md)
- [Category Bids](https://developers.criteo.com/marketing-solutions/docs/category-bids.md)
- [Display Multipliers](https://developers.criteo.com/marketing-solutions/docs/display-multipliers.md)
- [Campaigns](https://developers.criteo.com/marketing-solutions/docs/campaigns.md)
- [Catalog](https://developers.criteo.com/marketing-solutions/docs/catalog.md)
- [Product Sets](https://developers.criteo.com/marketing-solutions/docs/product-sets.md)
- [Commerce Grid Audience Segments Endpoints](https://developers.criteo.com/marketing-solutions/docs/commerce-grid-audience-segments-endpoints.md)
- [Commerce Grid](https://developers.criteo.com/marketing-solutions/docs/commerce-grid.md): This section documents the Commerce Grid API
- [Ads](https://developers.criteo.com/marketing-solutions/docs/ads.md)
- [Coupon](https://developers.criteo.com/marketing-solutions/docs/coupon.md)
- [Creatives](https://developers.criteo.com/marketing-solutions/docs/creative.md)
- [Creatives](https://developers.criteo.com/marketing-solutions/docs/creatives.md)
- [Marketplace Performance Outcomes](https://developers.criteo.com/marketing-solutions/docs/marketplace-performance-outcomes.md)
- [Onboarding to MPO](https://developers.criteo.com/marketing-solutions/docs/onboarding-to-mpo.md)
- [Campaigns- Concept Guide](https://developers.criteo.com/marketing-solutions/docs/campaigns-concept-guide-1.md)
- [Multi-Seller](https://developers.criteo.com/marketing-solutions/docs/multiseller.md)
- [Getting Statistics](https://developers.criteo.com/marketing-solutions/docs/multiseller-getting-statistics.md)
- [Managing Budgets](https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-budgets.md)
- [Managing Campaigns](https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns.md)
- [Managing Sellers](https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers.md)
- [Quick Start – Launch a Multi-Seller Campaign via MPO](https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-multi-seller-campaign-via-mpo.md)
- [Troubleshooting & FAQ](https://developers.criteo.com/marketing-solutions/docs/troubleshooting-faq.md)
- [MPO Real-Time Asynchronous API](https://developers.criteo.com/marketing-solutions/docs/getting-realtime-mpo-statistics.md)
- [Reporting](https://developers.criteo.com/marketing-solutions/docs/reporting.md)
- [MPO Standard Reporting API](https://developers.criteo.com/marketing-solutions/docs/mpo-standard-reporting-api.md)
- [Campaigns- Concept Guide](https://developers.criteo.com/marketing-solutions/docs/campaigns-concept-guide.md)
- [Getting Statistics ](https://developers.criteo.com/marketing-solutions/docs/getting-statistics.md)
- [Single-Seller](https://developers.criteo.com/marketing-solutions/docs/singleseller.md)
- [Managing Budgets](https://developers.criteo.com/marketing-solutions/docs/managing-budgets.md)
- [Managing Campaigns](https://developers.criteo.com/marketing-solutions/docs/managing-campaigns.md)
- [Managing Sellers](https://developers.criteo.com/marketing-solutions/docs/managing-sellers.md)
- [Quick Start – Launch a Single-Seller Campaign via MPO](https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-single-seller-campaign-via-mpo.md)
- [Troubleshooting & FAQ](https://developers.criteo.com/marketing-solutions/docs/troubleshooting-faq-1.md)
- [API Client Libraries](https://developers.criteo.com/marketing-solutions/docs/api-client-libraries.md)
- [API Troubleshooting Tips](https://developers.criteo.com/marketing-solutions/docs/api-troubleshooting-tips.md)
- [Criteo API Swagger](https://developers.criteo.com/marketing-solutions/docs/criteo-api-swagger.md)
- [Looker Studio Connector](https://developers.criteo.com/marketing-solutions/docs/looker-studio-connector.md)
- [Use Postman with the Criteo Marketing Solutions API](https://developers.criteo.com/marketing-solutions/docs/use-postman-with-the-criteo-marketing-solutions-api.md)
## API Reference
- [/oauth2/token](https://developers.criteo.com/marketing-solutions/reference/apiv1oauth2tokenpost.md): Creates a token when the supplied client credentials or single use authorization code are valid
- [listadvertisers](https://developers.criteo.com/marketing-solutions/reference/listadvertisers.md): Fetch the portfolio of Advertisers for this account
- [getadsetreport](https://developers.criteo.com/marketing-solutions/reference/getadsetreport.md): This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.
- [getplacementsreport](https://developers.criteo.com/marketing-solutions/reference/getplacementsreport.md): Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.
- [gettransactionsreport](https://developers.criteo.com/marketing-solutions/reference/gettransactionsreport.md): This Transactions endpoint provides transactions id related data.
- [gettransparencyreport](https://developers.criteo.com/marketing-solutions/reference/gettransparencyreport.md): This Statistics endpoint provides publisher data.
- [computeaudiencesegmentssizes](https://developers.criteo.com/marketing-solutions/reference/computeaudiencesegmentssizes.md): Gets the size of all segments. An error is returned for those whose size calculation is not supported.
- [computeaudiencessizes](https://developers.criteo.com/marketing-solutions/reference/computeaudiencessizes.md): Gets the size of all audiences. An error is returned for those whose size calculation is not supported.
- [createaudiences](https://developers.criteo.com/marketing-solutions/reference/createaudiences.md): Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.
- [createaudiencesegments](https://developers.criteo.com/marketing-solutions/reference/createaudiencesegments.md): Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.
- [deleteaudiences](https://developers.criteo.com/marketing-solutions/reference/deleteaudiences.md): Deletes the audiences associated to the given audience IDs.
- [deleteaudiencesegments](https://developers.criteo.com/marketing-solutions/reference/deleteaudiencesegments.md): Delete the segments associated to the given audience IDs.
- [deletecontactlistbyaudiencesegment](https://developers.criteo.com/marketing-solutions/reference/deletecontactlistbyaudiencesegment.md): Delete all identifiers from a contact list audience-segment.
- [estimateaudiencesegmentssizes](https://developers.criteo.com/marketing-solutions/reference/estimateaudiencesegmentssizes.md): Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.
- [estimateaudiencessizes](https://developers.criteo.com/marketing-solutions/reference/estimateaudiencessizes.md): Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.
- [getaudiencesegmentcontactliststatistics](https://developers.criteo.com/marketing-solutions/reference/getaudiencesegmentcontactliststatistics.md): Returns the statistics of a contact list segment.
- [getaudiencesegmentsinmarketbrands](https://developers.criteo.com/marketing-solutions/reference/getaudiencesegmentsinmarketbrands.md): Returns a list with all available in-market brands that can be used to define an in-market segment.
- [getaudiencesegmentsinmarketinterests](https://developers.criteo.com/marketing-solutions/reference/getaudiencesegmentsinmarketinterests.md): Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.
- [searchaudiences](https://developers.criteo.com/marketing-solutions/reference/searchaudiences.md): Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.
- [searchaudiencesegments](https://developers.criteo.com/marketing-solutions/reference/searchaudiencesegments.md): Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.
- [updateaudiences](https://developers.criteo.com/marketing-solutions/reference/updateaudiences.md): Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.
- [updateaudiencesegments](https://developers.criteo.com/marketing-solutions/reference/updateaudiencesegments.md): Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.
- [updatecontactlistbyaudiencesegment](https://developers.criteo.com/marketing-solutions/reference/updatecontactlistbyaudiencesegment.md): Add/remove identifiers to or from a contact list audience-segment.
- [createadset](https://developers.criteo.com/marketing-solutions/reference/createadset.md): Create the specified ad set
- [createcampaign](https://developers.criteo.com/marketing-solutions/reference/createcampaign.md): Create the specified campaign
A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.
- [createmarketplacesellerbudgets](https://developers.criteo.com/marketing-solutions/reference/createmarketplacesellerbudgets.md): Create one or more new budgets to enable spending with the given limitations.
All three types of budgets can be created this way.
The following constraints apply when creating a new budget.
• sellerId: the seller MUST be supplied
• campaignIds: a non-empty array of campaign ids MUST be supplied
• budgetType: a budget type MUST be supplied
• amount: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative
• startDate: a future start date MUST be supplied
• endDate: an end date MAY be supplied and if supplied MUST be greater than the start date
Other attributes MUST NOT be supplied.
- [createmarketplacesellercampaignsbyseller](https://developers.criteo.com/marketing-solutions/reference/createmarketplacesellercampaignsbyseller.md): Associate an existing Seller with an existing Campaign allowing for budget creation
- [getadset](https://developers.criteo.com/marketing-solutions/reference/getadset.md): Get the data for the specified ad set
- [getadsetcategorybids](https://developers.criteo.com/marketing-solutions/reference/getadsetcategorybids.md): Get the Category Bids for all valid Categories associated to an Ad Set
- [getcampaign](https://developers.criteo.com/marketing-solutions/reference/getcampaign.md): Get the data for the specified campaign.
A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.
- [getdisplaymultipliers](https://developers.criteo.com/marketing-solutions/reference/getdisplaymultipliers.md): Get the Display Multipliers for all valid Categories associated to an Ad Set
- [getmarketplaceadsetsbyadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceadsetsbyadvertiser.md): Get the collection of adsets associated with the advertiserId.
- [getmarketplaceadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceadvertiser.md): Get an advertiser.
- [getmarketplaceadvertiserpreviewlimits](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceadvertiserpreviewlimits.md): Get the collection of advertisers preview limits associated with the authorized user.
- [getmarketplaceadvertisers](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceadvertisers.md): Get the collection of advertisers associated with the user.
- [getmarketplacebudgetsbyadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplacebudgetsbyadvertiser.md): Get CRP budgets for a specific advertiser
- [getmarketplacebudgetsbyseller](https://developers.criteo.com/marketing-solutions/reference/getmarketplacebudgetsbyseller.md): Return current (non-archived) budgets for this seller. Budgets whose endDate is in the past are excluded by default. To retrieve archived or past budgets, use the `/budgets` endpoint (GetMarketplaceSellerBudgets) with the `endAfterDate` filter instead.
- [getmarketplacebudgetsbysellercampaign](https://developers.criteo.com/marketing-solutions/reference/getmarketplacebudgetsbysellercampaign.md): Return a collection of budgets for this seller campaign filtered by optional filter parameters.
If all parameters are omitted the entire collection to which the user has
access is returned, except those whose endDate is in the past. Returned budgets must satisfy all supplied filter
criteria if multiple parameters are used.
See the budgets endpoint for additional details.
- [getmarketplacecampaignsbyadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplacecampaignsbyadvertiser.md): Get the collection of CRP campaigns associated with the advertiserId.
- [getmarketplacecampaignsstats](https://developers.criteo.com/marketing-solutions/reference/getmarketplacecampaignsstats.md): ## Dimensions
Get performance statistics aggregated for _campaigns_. The campaign id appears
in the output as the first column.
Aggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone
if provided. The aggregation interval size is controlled by `intervalSize`. The time
interval appears in the output as the second column.
## Metrics
The metrics reported by this endpoint are
. | Metric Group | Description
---|--------------|------------
A | impressions | Number of times product is shown in a banner
B | clicks | Number of clicks on product
C | cost | Amount spent for clicks on products
D | saleUnits | Number of products sold attributed to clicks
E | revenue | Revenue generated by sales
F | CR = Conversion Rate | salesUnits / clicks
G | CPO = Cost Per Order | cost / salesUnits
H | COS = Cost of Sale | cost / revenue
I | ROAS = Return On Add Spend | revenue / cost
The last six metrics can be computed in two ways depending on the policy to count only
the sales that result from clicks on the same sellers product in a banner
(same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`.
The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.
## Filtering
The results can be filtered by campaign, date or count.
Filtering the results to events associated with a specific campaign is done by setting
the `campaignId` filter parameter to the desired value.
Filtering the results to events
that happened in a time interval is done by setting the `startDate` and
`endDate` filter parameters using the `yyyy-MM-DD` format. The start date
includes all events timestamped since the beginning of that day while the end
date includes events until the end of day. The maximum duration of the date
range is 1 year. If the aggregation interval is `hour`, then the maximum
duration of the date range is 31 days. Note that month and year aggregate values
may contain partial data for the interval if filtering by date.
Filtering the results to a maximum number of data rows is done by setting the
`count` filter parameter. When combined with startDate this can be used to perform
simple pagination.
## Response Format
The representation format can be specified by MIME values in the Accept header.
For now the only supported values for the accept header is `application/json` and
`text/csv`.
```json
{
"columns": [ "campaignId", "month", "impressions", "clicks", "cost", "saleUnits", "revenue", "cr", "cpo", "cos", "roas" ],
"data": [
[168423, "2019-05-01", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ],
[168423, "2019-06-01", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ]
],
"rows": 2
}
```
The JSON result is an object with three fields (`columns`, `data`, and `rows`). The
“columns” array acts as the header for the data rows. The categorical dimension
column comes first and consists of the campaign id.
The interval column comes next and defines the aggregation period. The interval size is
determined by the `intervalSize` parameter. This is followed by either nine or
fifteen metrics columns. The first three metrics (impressions, clicks, and cost)
always appear. The remaining depend on the `clickAttributionPolicy` parameter.
The “data” array contains data rows whose values match the entries in the
“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects
whose type is number. Some of these are natural numbers (e.g. clicks and
impressions) whereas others are decimal values. A divide by zero yields null. The
currency is assumed to be the local currency established by the advertiser.
The “row” value is a count of the number of rows in the data array, and can be
used to check the integrity of the data.
Further information on the campaign or seller (e.g. the seller name) can be
obtained from the existing V1 or V2 endpoints using the campaign and/or seller
ID values.
- [getmarketplaceseller](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceseller.md): Return details for the selected seller. For example,
{
"id" : "123456"
"sellerName": "HBogart",
}
- [getmarketplaceselleradpreview](https://developers.criteo.com/marketing-solutions/reference/getmarketplaceselleradpreview.md): Get a preview of an HTML ad with products belonging to the provided seller
• advertiserId: Valid crp advertiserId, seller belongs to provided advertiser
• sellerId: Products from given SellerId will fill the ad preview, must be existing crp sellerId
• height: height may be supplied to request a specific ad preview height. Default height: 250
• width: width may be supplied to request a specific ad preview width. Default width: 300
Ad preview api calls are capped to 1000 per day per advertiser by default. Current usage, limit, and period can be found using v2/crp/advertisers/preview-limit
- [getmarketplacesellerbudget](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellerbudget.md): Return a budget. For example,
{
"id": "1759183",
"sellerId": "321392",
"campaignIds": [
143962
],
"budgetType": "Capped",
"amount": 1000,
"startDate": "2021-01-11",
"endDate": "2021-01-12",
"spend": null,
"status": "Active"
}
A budget limits the spend of a seller for one or more campaigns.
There are three types of budget:
Uncapped budgets put no limit on the total amount of spend.
Capped budgets limit the total spend to a fixed amount.
Daily budgets limit daily spend to a fixed amount.
In addition, budgets can limit the spend to a specific range of dates using
the start and end date attributes. Finally a budget must be active to be used.
Spend approximates the current spend against this budget. There may be a lag
between when an ad is clicked and the time it accrues to the spend. Daily budgets
show spend against the most recent day only.
- [getmarketplacesellerbudgets](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellerbudgets.md): Return a collection of budgets filtered by optional filter parameters, **including archived budgets**. This is the endpoint to use when investigating past budget history.
By default, budgets whose endDate is in the past are excluded. Use `endAfterDate` to retrieve archived budgets (e.g. `endAfterDate=2025-01-01` returns all budgets ending after that date). Use `sellerId` to filter to a specific seller — omitting it on large advertisers causes timeouts.
Date filter. To find budgets that were active on a specific date, set both `startBeforeDate` and `endAfterDate` to that day.
Spend. If `endAfterDate` is supplied, the spend excludes spend that happened after that date. For daily budgets, only the spend for the final day is displayed.
- [getmarketplacesellercampaign](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellercampaign.md): Return details for a seller campaign. For example,
{
"id": "543210.123456",
"sellerId": "543210",
"campaignId": 123456,
"bid": 1.55,
"suspendedSince": "2018-07-30T15:15:24.813",
"suspensionReasons": [
"NoMoreBudget"
]
}
An active seller campaign is one for which the value of suspendedSince is null and
the bid is positive. The currency of the bid is the bidCurrency of the
associated campaign.
Any active seller campaign must also have an active total (capped or uncapped) budget.
It may optionally have an active daily budget as well to further limit spending.
Suspension reasons:
- ManuallyStopped: The Seller-Campaign has been manually paused. This is not related to the other suspension reasons.
- NoBudgetDefined: No valid budget has been linked to the Seller-Campaign.
- NoCpcDefined: No CPC has been set for the Seller-Campaign.
- NoMoreBudget: The current budget of the Seller-Campaign has been exhausted.
- RemovedFromCatalog: All the products of the Seller-Campaign have been deleted from the catalog.
- NotYetStarted: The Seller-Campaign has just been created and has not yet been processed.
- [getmarketplacesellercampaigns](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellercampaigns.md): Return a collection of seller campaigns filtered by optional filter parameters.
If all parameters are omitted the entire collection to which the user has
access is returned. Returned sellers must satisfy all supplied filter
criteria if multiple parameters are used.
- [getmarketplacesellercampaignsbyadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellercampaignsbyadvertiser.md): Get CRP seller campaigns for a specific advertiser
- [getmarketplacesellercampaignsbyseller](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellercampaignsbyseller.md): Return a collection of seller campaigns for this seller filtered by optional filter parameters.
If all parameters are omitted the entire collection to which the user has
access is returned. Returned sellers must satisfy all supplied filter
criteria if multiple parameters are used. See the seller campaigns endpoint for additional details.
- [getmarketplacesellercampaignsstats](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellercampaignsstats.md): ## Dimensions
Get performance statistics aggregated for _seller campaigns_.The campaign id, seller id, and
seller name appear in the first three columns of the output. These are followed by the interval
size column.
Aggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone if
provided. The aggregation interval size is controlled by `intervalSize`. The remaining columns
are metrics.
## Metrics
The metrics reported by this endpoint are
. | Metric Group | Description
---|--------------|------------
A | impressions | Number of times product is shown in a banner
B | clicks | Number of clicks on product
C | cost | Amount spent for clicks on products
D | saleUnits | Number of products sold attributed to clicks
E | revenue | Revenue generated by sales
F | CR = Conversion Rate | salesUnits / clicks
G | CPO = Cost Per Order | cost / salesUnits
H | COS = Cost of Sale | cost / revenue
I | ROAS = Return On Add Spend | revenue / cost
The last six metrics can be computed in two ways depending on the policy to count only
the sales that result from clicks on the same sellers product in a banner
(same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`.
The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.
## Filtering
The results can be filtered by date or count.
Filtering the results to events associated with a specific campaign is done by setting
the `campaignId` filter parameter to the desired value.
Filtering the results to events associated with a specific seller is done by setting
the `sellerId` filter parameter to the desired value.
Filtering the results to events
that happened in a time interval is done by setting the `startDate` and
`endDate` filter parameters using the `yyyy-MM-DD` format. The start date
includes all events timestamped since the beginning of that day while the end
date includes events until the end of day. The maximum duration of the date
range is 1 year. If the aggregation interval is `hour`, then the maximum
duration of the date range is 31 days. Note that month and year aggregate values
may contain partial data for the interval if filtering by date.
Filtering the results to a maximum number of data rows is done by setting the
`count` filter parameter. When combined with startDate this can be used to perform
simple pagination.
## Response Format
The representation format can be specified by MIME values in the Accept header.
For now the only supported values for the accept header is `application/json` and
`text/csv`.
```json
{
"columns": [
"campaignId", "sellerId", "sellerName", "month", "impressions", "clicks", "cost", "saleUnits", "revenue", "cr", "cpo", "cos", "roas"
],
"data": [
[168423, 1110222, "118883955", "2019-05-01", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],
[168423, 1110222, "118883955", "2019-06-01", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],
[168423, 1110225, "117980027", "2019-05-01", 12502, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],
[168423, 1110225, "117980027", "2019-06-01", 20266, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0]
],
"rows": 4
}
```
The JSON result is an object with three fields (`columns`, `data`, and `rows`). The
“columns” array acts as the header for the data rows. The categorical dimension
columns come first and include the campaign id, seller id, and seller name.
The interval column comes next and defines the aggregation period. The interval size is
determined by the `intervalSize` parameter. This is followed by either nine or
fifteen metrics columns. The first three metrics (impressions, clicks, and cost)
always appear. The remaining depend on the `clickAttributionPolicy` parameter.
The “data” array contains data rows whose values match the entries in the
“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects
whose type is number. Some of these are natural numbers (e.g. clicks and
impressions) whereas others are decimal values. A divide by zero yields null. The
currency is assumed to be the local currency established by the advertiser.
The “row” value is a count of the number of rows in the data array, and can be
used to check the integrity of the data.
Further information on the campaign or seller (e.g. the seller name) can be
obtained from the existing V1 or V2 endpoints using the campaign and/or seller
ID values.
- [getmarketplacesellers](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellers.md): Return a collection of sellers filtered by optional filter parameters.
If all parameters are omitted the entire collection to which the user has
access is returned. Returned sellers must satisfy all supplied filter
criteria if multiple parameters are used.
- [getmarketplacesellersbyadvertiser](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellersbyadvertiser.md): Create new sellers for an advertiser
- [getmarketplacesellersstats](https://developers.criteo.com/marketing-solutions/reference/getmarketplacesellersstats.md): ## Dimensions
Get performance statistics aggregated for _sellers_. The seller id appears
in the output in the first column and the seller name appears in the second.
Aggregation can be done by `hour`, `day`, `month`, or `year` aligned with the user timezone
if provided. The aggregation interval size is controlled by `intervalSize`. The time interval
appears in the output as the second column.
## Metrics
The metrics reported by this endpoint are
. | Metric Group | Description
---|--------------|------------
A | impressions | Number of times product is shown in a banner
B | clicks | Number of clicks on product
C | cost | Amount spent for clicks on products
D | saleUnits | Number of products sold attributed to clicks
E | revenue | Revenue generated by sales
F | CR = Conversion Rate | salesUnits / clicks
G | CPO = Cost Per Order | cost / salesUnits
H | COS = Cost of Sale | cost / revenue
I | ROAS = Return On Add Spend | revenue / cost
The last six metrics can be computed in two ways depending on the policy to count only
the sales that result from clicks on the same sellers product in a banner
(same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`.
The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns.
## Filtering
The results can be filtered by seller id, date or count.
Filtering the results to events associated with a specific seller is done by setting
the `sellerId` filter parameter to the desired value.
Filtering the results to events
that happened in a time interval is done by setting the `startDate` and
`endDate` filter parameters using the `yyyy-MM-DD` format. The start date
includes all events timestamped since the beginning of that day while the end
date includes events until the end of day. The maximum duration of the date
range is 1 year. If the aggregation interval is `hour`, then the maximum
duration of the date range is 31 days. Note that month and year aggregate values
may contain partial data for the interval if filtering by date.
Filtering the results to a maximum number of data rows is done by setting the
`count` filter parameter. When combined with startDate this can be used to perform
simple pagination.
## Response Format
The representation format can be specified by MIME values in the Accept header.
For now the only supported values for the accept header is `application/json` and
`text/csv`.
```json
{
"columns": ["sellerId", "sellerName", "month", "impressions", "clicks", "cost", "saleUnits", "revenue", "cr", "cpo", "cos", "roas"],
"data": [
[1200972, "sellerA", "2019-05-01", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0],
[1200972, "sellerA", "2019-06-01", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0],
[1200974, "sellerB", "2019-05-01", 10102, 47, 3.29, 3, 396000.0, 0.063, 1.096, 8.308E-6, 120364.741],
[1200974, "sellerB", "2019-06-01", 11576, 54, 3.78, 1, 132000.0, 0.018, 3.78, 2.863E-5, 34920.634]
],
"rows": 4
}
```
The JSON result is an object with three fields (`columns`, `data`, and `rows`). The
“columns” array acts as the header for the data rows. The categorical dimension
columns come first and include the seller id and seller name.
The interval column comes next and defines the aggregation period. The interval size is
determined by the `intervalSize` parameter. This is followed by either nine or
fifteen metrics columns. The first three metrics (impressions, clicks, and cost)
always appear. The remaining metrics depend on the `clickAttributionPolicy` parameter.
The “data” array contains data rows whose values match the entries in the
“columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects
whose type is number. Some of these are natural numbers (e.g. clicks and
impressions) whereas others are decimal values. A divide by zero yields null. The
currency is assumed to be the local currency established by the advertiser.
The “row” value is a count of the number of rows in the data array, and can be
used to check the integrity of the data.
Further information on the campaign or seller (e.g. the seller name) can be
obtained from the existing V1 or V2 endpoints using the campaign and/or seller
ID values.
- [patchadsetcategorybids](https://developers.criteo.com/marketing-solutions/reference/patchadsetcategorybids.md): Update the Category Bids for given Categories associated to an Ad Set
Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.
- [patchadsets](https://developers.criteo.com/marketing-solutions/reference/patchadsets.md): Patch a list of AdSets.
- [patchcampaigns](https://developers.criteo.com/marketing-solutions/reference/patchcampaigns.md): Patch a list of Campaigns.
A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.
- [patchdisplaymultipliers](https://developers.criteo.com/marketing-solutions/reference/patchdisplaymultipliers.md): Update the Display Multipliers for given Categories associated to an Ad Set
Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.
- [searchadsets](https://developers.criteo.com/marketing-solutions/reference/searchadsets.md): Search for ad sets
- [searchcampaigns](https://developers.criteo.com/marketing-solutions/reference/searchcampaigns.md): Search endpoint for campaigns
A campaign, or in other words a marketing campaign, is an entity that defines advertising objectives and success criteria.
- [startadsets](https://developers.criteo.com/marketing-solutions/reference/startadsets.md): Start the specified list of ad sets
- [stopadsets](https://developers.criteo.com/marketing-solutions/reference/stopadsets.md): Stop the specified list of ad sets
- [updateadsetaudience](https://developers.criteo.com/marketing-solutions/reference/updateadsetaudience.md): Link or unlink an audience with an ad set
- [updatemarketplacesellerbudget](https://developers.criteo.com/marketing-solutions/reference/updatemarketplacesellerbudget.md): Modify an existing active budget to change its limitations or status.
All three types of budgets can be modified.
See the additional restrictions listed in the PATCH budgets endpoint.
- [updatemarketplacesellerbudgets](https://developers.criteo.com/marketing-solutions/reference/updatemarketplacesellerbudgets.md): Modify one or more existing active budgets to change their limitations or status.
All three types of budgets can be modified.
The following constraints apply when modifying an existing budget.
• campaignIds: a non-empty subset of the original campaign ids MAY be supplied
• amount: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative
• startDate: a future start date MAY be supplied for budgets that have not yet started
• endDate: an end date MAY be supplied and if supplied MUST be a future date greater than the start date
Other attributes MUST NOT be supplied.
Adding new campaigns to a budget is not allowed. In addition, reducing the amount for
a Capped budget to a value less than the current spend not allowed.
- [updatemarketplacesellercampaign](https://developers.criteo.com/marketing-solutions/reference/updatemarketplacesellercampaign.md): Patching a seller campaign allows the bid to be modified. The bid must be a non-negative value.
Setting the bid to zero will make a seller campaign inactive.
The currency used for bids will be the default currency of the campaign.
- [updatemarketplacesellercampaigns](https://developers.criteo.com/marketing-solutions/reference/updatemarketplacesellercampaigns.md): Patching a collection of seller campaigns allows their bids to be modified.
Each bid must be a non-negative value. Setting the bid to zero will make a seller campaign inactive.
The currency used for bids will be the default currency of the campaign.
- [createadvertiserad](https://developers.criteo.com/marketing-solutions/reference/createadvertiserad.md): Create an Ad
- [createadvertisercoupon](https://developers.criteo.com/marketing-solutions/reference/createadvertisercoupon.md): Create a Coupon
- [createadvertisercreative](https://developers.criteo.com/marketing-solutions/reference/createadvertisercreative.md): Create a Creative
- [deletead](https://developers.criteo.com/marketing-solutions/reference/deletead.md): Delete an Ad
- [deleteadvertisercoupon](https://developers.criteo.com/marketing-solutions/reference/deleteadvertisercoupon.md): Delete a Coupon
- [deletecreative](https://developers.criteo.com/marketing-solutions/reference/deletecreative.md): Delete a Creative if there are no ads binded to it
- [editadvertisercoupon](https://developers.criteo.com/marketing-solutions/reference/editadvertisercoupon.md): Edit a specific Coupon
- [editcreative](https://developers.criteo.com/marketing-solutions/reference/editcreative.md): Edit a specific Creative
- [generatecreativepreview](https://developers.criteo.com/marketing-solutions/reference/generatecreativepreview.md): Get the preview of a specific Creative
- [getad](https://developers.criteo.com/marketing-solutions/reference/getad.md): Get an Ad with its id
- [getadvertiserads](https://developers.criteo.com/marketing-solutions/reference/getadvertiserads.md): Get the list of self-services Ads for a given advertiser
- [getadvertisercoupon](https://developers.criteo.com/marketing-solutions/reference/getadvertisercoupon.md): Get a Coupon with its id
- [getadvertisercouponpreview](https://developers.criteo.com/marketing-solutions/reference/getadvertisercouponpreview.md): Get the preview of a specific Coupon
- [getadvertisercoupons](https://developers.criteo.com/marketing-solutions/reference/getadvertisercoupons.md): Get the list of self-services Coupons for a given advertiser
- [getadvertisercouponsupportedsizes](https://developers.criteo.com/marketing-solutions/reference/getadvertisercouponsupportedsizes.md): Get the list of Coupon supported sizes
- [getadvertisercreatives](https://developers.criteo.com/marketing-solutions/reference/getadvertisercreatives.md): Get the list of self-services Creatives for a given advertiser
- [getcreative](https://developers.criteo.com/marketing-solutions/reference/getcreative.md): Get a Creative with its id
- [getcurrentapplication](https://developers.criteo.com/marketing-solutions/reference/getcurrentapplication.md): Get information about the currently logged application
- [createproductset](https://developers.criteo.com/marketing-solutions/reference/createproductset.md): Create a new product set
- [disableproductfiltering](https://developers.criteo.com/marketing-solutions/reference/disableproductfiltering.md): Disable product filtering for a given ad
- [enableproductfiltering](https://developers.criteo.com/marketing-solutions/reference/enableproductfiltering.md): Enable product filtering for a given ad
- [fetchproductfilteringconfig](https://developers.criteo.com/marketing-solutions/reference/fetchproductfilteringconfig.md): Fetch product filtering configuration for a given ad
- [fetchproductfilteringusages](https://developers.criteo.com/marketing-solutions/reference/fetchproductfilteringusages.md): Fetch product filtering usages for a given product set
- [fetchproductset](https://developers.criteo.com/marketing-solutions/reference/fetchproductset.md): Fetch an existing product set
- [fetchproductsets](https://developers.criteo.com/marketing-solutions/reference/fetchproductsets.md): Fetch product sets of a given dataset
- [patchproductset](https://developers.criteo.com/marketing-solutions/reference/patchproductset.md): Patch an existing product set
- [removeproductset](https://developers.criteo.com/marketing-solutions/reference/removeproductset.md): Remove a product set
- [/2026-01/commerce-grid/audience-segments/{audience-segment-id}/contact-list/add-remove](https://developers.criteo.com/marketing-solutions/reference/addremovecontactlistbyaudiencesegment.md): Add/remove identifiers to or from a Commerce Grid audience segment of type Contact List.
- [/2026-01/commerce-grid/audience-segments/create](https://developers.criteo.com/marketing-solutions/reference/bulkcreateaudiencesegments.md): Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned.
- [/2026-01/commerce-grid/audience-segments/delete](https://developers.criteo.com/marketing-solutions/reference/bulkdeleteaudiencesegments.md): Delete the segments associated to the given IDs.
- [/2026-01/commerce-grid/audience-segments](https://developers.criteo.com/marketing-solutions/reference/bulkupdateaudiencesegments.md): Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned.
- [/2026-01/commerce-grid/audience-segments/{audience-segment-id}/contact-list/clear](https://developers.criteo.com/marketing-solutions/reference/clearcontactlistbyaudiencesegment.md): Delete all identifiers from a Commerce Grid audience segment of type Contact List.
- [/2026-01/commerce-grid/audience-segments/{audience-segment-id}/contact-list/statistics](https://developers.criteo.com/marketing-solutions/reference/getaudiencesegmentcontactliststatistics-1.md): Returns the statistics of a contact list segment.
- [/2026-01/commerce-grid/audience-segments/search](https://developers.criteo.com/marketing-solutions/reference/searchaudiencesegments-1.md): Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.
## Changelog
- [API Release Schedule & Versioning Policy Update](https://developers.criteo.com/marketing-solutions/changelog/api-release-schedule-versioning-policy-update.md)
- [Version 2026.01 Release Note](https://developers.criteo.com/marketing-solutions/changelog/version-202601-release-note.md)
- [Version 2025.10 Release Notes](https://developers.criteo.com/marketing-solutions/changelog/version-202510-release-notes.md)
- [Version 2025.07 Release Notes](https://developers.criteo.com/marketing-solutions/changelog/version-202507-release-notes.md)
- [Version 2025.04 Release Notes](https://developers.criteo.com/marketing-solutions/changelog/version-202504-release-notes.md)