### Get Seller Budgets Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers Example JSON response showing a list of budget objects for a seller. ```json [ { "id": "123456", "sellerId": "123456", "campaignIds": [ 123532 ], "budgetType": "Daily", "amount": 12.0000, "startDate": "2021-02-25", "endDate": "Never", "spend": null, "status": "Current", "isSuspended": false } ] ``` -------------------------------- ### POST /marketing-solutions/ad-sets/start Source: https://developers.criteo.com/marketing-solutions/docs/ad-set Starts delivery for one or more Ad Sets. ```APIDOC ## POST /marketing-solutions/ad-sets/start ### Description Sets one or more Ad Sets to start delivery. ### Method POST ### Endpoint /marketing-solutions/ad-sets/start ### Request Body - **data** (array) - Required - An array of Ad Set objects containing type and id. ### Request Example { "data": [ { "type": "AdSetId", "id": "12345" }, { "type": "AdSetId", "id": "67890" } ] } ### Response #### Success Response (200) - **data** (array) - An array of Ad Sets that were started successfully. #### Response Example { "data": [ { "type": "AdSetId", "id": "12345" }, { "type": "AdSetId", "id": "67890" } ], "errors": [], "warnings": [] } ``` -------------------------------- ### Example MPO Report Request Source: https://developers.criteo.com/marketing-solutions/docs/getting-realtime-mpo-statistics A sample GET request to retrieve a specific report by its UUID. ```http GET https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/stats/realtime-reports/45f7ec55-1008-4372-9144-1da37d8dccc2 ``` -------------------------------- ### Coupon List Response Example Source: https://developers.criteo.com/marketing-solutions/docs/coupon Example JSON response containing a list of coupon objects for an advertiser. ```json { "data": [ { "type": "Coupon", "id": "18", "attributes": { "name": "My first coupon", "description": "Description of my first coupon", "author": "r.deckard", "advertiserId": "51", "adSetId": "345", "landingPageUrl": "https://my-landing-page.com", "startDate": "2021-11-23T18:25:43.511Z", "format": "LogoZone", "status": "Live", "images": [ { "width": 300, "height": 250, "slideUrls": ["https://static.criteo.net/image_1.jpg"] }, { "width": 130, "height": 90, "slideUrls": ["https://static.criteo.net/image_2.jpg"] } ], "showEvery": 3, "showDuration": 3, "rotationsNumber": 2, "id": "18", } }, { "type": "Coupon", "id": "19", "attributes": { "name": "My second Coupon", "description": "Description of my second coupon", "author": "r.deckard", "advertiserId": "51", "adSetId": "502", "landingPageUrl": "https://my-landing-page.com", "startDate": "2021-12-19T18:25:43.511Z", "endDate": "2022-01-01T10:00:00.511Z", "format": "FullFrame", "status": "Live", "images": [ { "width": 300, "height": 250, "slideUrls": ["https://static.criteo.net/image_1.jpg", "https://static.criteo.net/another-imagejpg"] }, { "width": 120, "height": 600, "slideUrls": ["https://static.criteo.net/image_2.jpg", "https://static.criteo.net/alternative-image.jpg"] } ], "showEvery": 1, "showDuration": 1, "rotationsNumber": 3, "id": "19" } ], "errors": [ ] /* omitted if no errors */ "warnings": [ ] /* omitted if no warnings */ } ``` -------------------------------- ### Specific Coupon Response Example Source: https://developers.criteo.com/marketing-solutions/docs/coupon Example JSON response for a single coupon retrieval request. ```json { "data": { "type": "Coupon", "id": "18", "attributes": { "name": "My first coupon", "description": "Description of my first coupon", "author": "r.deckard", "advertiserId": "51", "adSetId": "345", "landingPageUrl": "https://my-landing-page.com", "startDate": "2021-11-23T18:25:43.511Z", "format": "LogoZone", "images": [ { "width": 300, "height": 250, "slideUrls": ["https://static.criteo.net/image_1.jpg"] }, { "width": 130, "height": 90, "slideUrls": ["https://static.criteo.net/image_2.jpg"] } ], "showEvery": 3, "showDuration": 3, "rotationsNumber": 2 } }, "errors": [ ], /* omitted if no errors */ "warnings": [ ] /* omitted if no warnings */ } ``` -------------------------------- ### GET /preview/product-sets/{productSetId} Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Retrieves information for a specific product set. ```APIDOC ## GET /preview/product-sets/{productSetId} ### Description Retrieves the information of a specific Product Set. ### Method GET ### Endpoint https://api.criteo.com/preview/product-sets/{productSetId} ### Parameters #### Path Parameters - **productSetId** (string) - Required - The ID of the product set to retrieve. ### Response #### Success Response (200) - **data** (object) - The product set object. - **warnings** (array) - List of warnings. - **errors** (array) - List of errors. ``` -------------------------------- ### Sample response for a specific Seller-Campaign Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns Example JSON response for a single Seller-Campaign object. ```json { "id": "543210.123456", "sellerId": "543210", "campaignId": 123456, "bid": 1.55, "suspendedSince": "2018-07-30T15:15:24.813", "suspensionReasons": [ "NoMoreBudget" ] } ``` -------------------------------- ### Get Specific Seller Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers Example JSON response containing seller identification details. ```json { "id": "123456", "sellerName": "HBogart" } ``` -------------------------------- ### Preview Coupon Response Source: https://developers.criteo.com/marketing-solutions/docs/coupon Example response containing the HTML preview of the requested coupon. ```json { "data": { "type": "CouponPreview", "attributes": { "previewHtml": " " } }, "errors": [ ], /* omitted if no errors */ "warnings": [ ]/* omitted if no warnings */ } ``` -------------------------------- ### Creative Preview Response Source: https://developers.criteo.com/marketing-solutions/docs/creative Example of the HTML response returned by the preview endpoint. ```html ... ...
Click me!
... ``` -------------------------------- ### Sample Seller Campaigns Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers An example of the JSON structure returned when querying seller campaigns. ```json [ { "id": "10624700.225662", "sellerId": "10624700", "campaignId": 225662, "bid": null, "suspendedSince": "2021-03-07T23:06:15.17", "suspensionReasons": [ "NoBudgetDefined" ] } ] ``` -------------------------------- ### GET /preview/product-sets/dataset/{datasetId} Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Retrieves all product sets associated with a specific data set. ```APIDOC ## GET /preview/product-sets/dataset/{datasetId} ### Description Retrieves all the Product Sets for a specific Data Set. ### Method GET ### Endpoint https://api.criteo.com/preview/product-sets/dataset/{datasetId} ### Parameters #### Path Parameters - **datasetId** (string) - Required - The ID of the data set. ### Response #### Success Response (200) - **data** (array) - A list of product sets. - **warnings** (array) - List of warnings. - **errors** (array) - List of errors. ``` -------------------------------- ### Sample Seller Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers Example JSON response structure containing seller IDs and names. ```json [{ "id" : "1", "sellerName": "AHepburn", },{ "id" : "2", "sellerName": "HBogart" },{ "id" : "3", "sellerName": "NewTech" }] ``` -------------------------------- ### Response Example for Specific Creative Source: https://developers.criteo.com/marketing-solutions/docs/creative JSON response structure for a single creative object. ```json { "data": { "id": "18", "type": "Creative", "attributes": { "name": "My image", "description": "Description of the creative", "author": "r.deckard", "status": "Live", "format": "Image", "advertiserId": "51", "datasetId": "49", "imageAttributes": { "urls": [ "https://static.criteo.net/image_1.jpg", "https://static.criteo.net/image_2.jpg" ], "landingPageUrl": "https://my-landing-page.com" }, "id": "18" } }, "errors": [], "warnings": [] } ``` -------------------------------- ### cURL Request for Access Token Source: https://developers.criteo.com/marketing-solutions/docs/authorization-code-setup Example of using cURL to perform the token exchange. ```sh curl -L 'https://api.criteo.com/oauth2/token?grant_type=authorization_code&client_id=&client_secret=&redirect_uri=' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'client_id=' \ -d 'client_secret=' \ -d 'redirect_uri=' \ -d 'code=' \ -d 'grant_type=authorization_code' ``` -------------------------------- ### Example Response for Specific Ad Source: https://developers.criteo.com/marketing-solutions/docs/ads JSON response body containing the details of a single ad. ```json { "data": { "id": "15", "type": "Ad", "attributes": { "name": "My first ad", "description": "Description of my first ad", "creativeId": "18", "adSetId": "345", "startDate": "2021-09-08T08:47:30.000Z", "endDate": "2021-10-08T08:47:30.000Z" } }, "warnings": [], "errors": [] } ``` -------------------------------- ### Campaign JSON data structure Source: https://developers.criteo.com/marketing-solutions/docs/campaign Example of the required JSON structure for a Campaign object. ```json { "type": "Campaign", "attributes": { "name": "My Campaign", "advertiserId": "12345", "goal": "Retention", "spendLimit": { "spendLimitType": "capped", "spendLimitRenewal": "daily", "spendLimitAmount": 123.45 }, "budgetAutomation": { "enabled": true, "budgetConfiguration": { "adSetObjectives": "conversions" } } } } ``` -------------------------------- ### Get Specific Campaign Response Source: https://developers.criteo.com/marketing-solutions/docs/campaign Example response structure for a single campaign retrieval. ```json { "data": { "type": "Campaign", "id": "99999", "attributes": { "name": "My Campaign", "advertiserId": "12345", "goal": "Retention", "spendLimit": { "spendLimitType": "capped", "spendLimitRenewal": "daily", "spendLimitAmount": 123.45 }, "budgetAutomation": { "enabled": true, "automatedBudgetConfiguration": { "adSetOptimizationObjective": "conversions" } } } }, "errors": [] } ``` -------------------------------- ### Create Product Set Response Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Example JSON response returned after a successful product set creation. ```json { "data": { "attributes": { "datasetId": "string", "name": "string", "status": "Unknown", "isEnabled": true, "numberOfProducts": 0, "creationDate": "string", "rules": [ { "operator": "IsIn", "field": "Category1", "values": [ "string" ] } ], "id": "string" }, "id": "string", "type": "string" }, "warnings": [], "errors": [] } ``` -------------------------------- ### Inspect productSet configuration in campaign response Source: https://developers.criteo.com/marketing-solutions/docs/managing-campaigns Example JSON response showing a configured productSet with an inclusion rule for specific product SKUs. ```json { "data": [ { "id": "SELLER_123.TEMPLATE_CAMPAIGN_456", "sellerId": "SELLER_123", "campaignId": "TEMPLATE_CAMPAIGN_456", "productSet": { "rules": [ { "operator": "IsIn", "field": "ExternalItemId", "values": [ "SKU_1", "SKU_2", "SKU_3" ] } ], "productSetStatus": "Valid", "productSetNumberOfProducts": 3 } } ] } ``` -------------------------------- ### POST /preview/product-sets/preview Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Tests product set rules by returning the number of products that match the criteria and a sample of those products. ```APIDOC ## POST https://api.criteo.com/preview/product-sets/preview ### Description Tests product set rules by returning the number of products that match the criteria and a sample of those products. ### Method POST ### Endpoint https://api.criteo.com/preview/product-sets/preview ### Request Body - **productSet** (object) - Required - The definition of the product set including datasetId and rules. - **productSampleCount** (integer) - Required - The number of sample products to return. ### Request Example { "productSet": { "datasetId": "782", "rules": [ { "operator": "IsIn", "field": "Category1", "values": [ "Decoration", "Home", "Furniture" ] }, { "operator": "IsNotIn", "field": "Category2", "values": [ "Games", "Gastronomy" ] } ] }, "productSampleCount": 5 } ### Response #### Success Response (200) - **data** (object) - Contains productCount, totalProductCount, and sampleProducts. - **warnings** (array) - List of warnings. #### Response Example { "data": { "productCount": 3940, "totalProductCount": 404202, "sampleProducts": [ "-9063027279849067663", "927588690310362953", "667545005484734956", "-6270815052645770065", "-9213562868104252217" ] }, "warnings": [] } ``` -------------------------------- ### GET https://api.criteo.com/2020-10/advertisers/me Source: https://developers.criteo.com/marketing-solutions/docs/authentication Example of how to authenticate a request by including the Authorization header with a Bearer token. ```APIDOC ## GET https://api.criteo.com/2020-10/advertisers/me ### Description This request demonstrates how to authenticate against the Criteo API by providing an access token in the Authorization header. ### Method GET ### Endpoint https://api.criteo.com/2020-10/advertisers/me ### Request Headers - **Authorization** (string) - Required - Bearer - **Accept** (string) - Required - text/plain - **Content-Type** (string) - Required - application/*+json ``` -------------------------------- ### Preview Product Set Rules Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Use this endpoint to validate product set rules and retrieve a sample of matching products. ```http https://api.criteo.com/preview/product-sets/preview ``` ```json { "productSet": { "datasetId": "782", "rules": [ { "operator": "IsIn", "field": "Category1", "values": [ "Decoration", "Home", "Furniture" ] }, { "operator": "IsNotIn", "field": "Category2", "values": [ "Games", "Gastronomy" ] } ] }, "productSampleCount": 5 } ``` ```json { "data": { "productCount": 3940, "totalProductCount": 404202, "sampleProducts": [ "-9063027279849067663", "927588690310362953", "667545005484734956", "-6270815052645770065", "-9213562868104252217" ] }, "warnings": [] } ``` -------------------------------- ### Define Node.js Project Dependencies Source: https://developers.criteo.com/marketing-solutions/docs/authorization-code-setup Lists the required npm packages and start script for the demo application. ```json { "name": "oauth-node", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "start": "node index.js" }, "author": "", "license": "ISC", "dependencies": { "ejs": "^3.1.6", "express": "^4.17.1", "passport": "^0.4.1", "passport-oauth2": "^1.6.0" } } ``` -------------------------------- ### Get Specific Campaign Endpoint Source: https://developers.criteo.com/marketing-solutions/docs/campaign The GET endpoint used to retrieve details for a single campaign by its ID. ```http https://api.criteo.com/2026-01/marketing-solutions/campaigns/{campaign-id} ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/seller-campaigns Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns Retrieves a list of all available Seller-Campaigns. ```APIDOC ## GET /marketing-solutions/marketplace-performance-outcomes/seller-campaigns ### Description Retrieves a list of all available Seller-Campaigns. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/seller-campaigns ### Response #### Success Response (200) - **id** (string) - Unique identifier of the seller campaign - **suspendedSince** (string) - Timestamp when the campaign was suspended - **suspensionReasons** (array) - List of reasons for suspension - **sellerId** (string) - Identifier of the seller - **campaignId** (integer) - Identifier of the campaign - **bid** (number) - Current bid value #### Response Example [ { "id": "1.10001", "suspendedSince": "2018-07-30T18:00:13.333", "suspensionReasons": ["NoMoreBudget"], "sellerId": "1", "campaignId": 10001, "bid": null } ] ``` -------------------------------- ### Create Coupon Response Source: https://developers.criteo.com/marketing-solutions/docs/coupon Example response returned after successfully creating a new coupon, including the generated coupon ID. ```json { "data": { "type": "Coupon", "id": "18", "attributes": { "name": "New coupon", "description": "Description of my new coupon", "author": "r.deckard", "advertiserId": "510", "adSetId": "345", "landingPageUrl": "https://my-landing-page.com", "startDate": "2021-11-24T18:25:43.511Z", "format": "FullFrame", "images": [ { "width": 300, "height": 250, "slideUrls": [ "https://static.criteo.net/image.jpg", "https://static.criteo.net/image-2.jpg" ] } ], "showEvery": 1, "showDuration": 1, "rotationsNumber": 1, "id": "18" } }, "errors": [ ], /* omitted if no errors */ "warnings": [ ] /* omitted if no errors */ } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/sellers Source: https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-single-seller-campaign-via-mpo Retrieves the internal sellerId by filtering with the sellerName. ```APIDOC ## GET https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/sellers ### Description Use this endpoint to find the internal sellerId for a specific seller by providing their name. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/sellers?sellerName={YourSellerName} ### Parameters #### Query Parameters - **sellerName** (string) - Required - The name of the seller to filter by. ### Response #### Success Response (200) - **id** (string) - The internal sellerId. - **sellerName** (string) - The name of the seller. ``` -------------------------------- ### Start Ad Set Delivery via POST Source: https://developers.criteo.com/marketing-solutions/docs/ad-set Initiates delivery for one or more ad sets. ```http /marketing-solutions/ad-sets/start ``` ```json { "data": [ { "type": "AdSetId", "id": "12345" }, { "type": "AdSetId", "id": "67890" } ] } ``` ```json { "data": [ { "type": "AdSetId", "id": "12345" }, { "type": "AdSetId", "id": "67890" } ], "errors": [], "warnings": [] } ``` -------------------------------- ### Create Campaign Request Sample Source: https://developers.criteo.com/marketing-solutions/docs/campaign Example JSON payload for creating a new campaign with a capped spend limit and budget automation enabled. ```json { "data": { "type": "Campaign", "attributes": { "name": "My Campaign", "advertiserId": "12345", "goal": "Retention", "spendLimit": { "spendLimitType": "capped", "spendLimitRenewal": "daily", "spendLimitAmount": 123.45 }, "budgetAutomation": { "enabled": true, "budgetConfiguration": { "adSetObjectives": "conversions" } } } } } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns Source: https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-multi-seller-campaign-via-mpo Retrieves granular performance statistics per seller-campaign. ```APIDOC ## GET https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns ### Description Retrieves granular performance statistics for a specific seller within a campaign. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns ### Parameters #### Query Parameters - **campaignId** (string) - Required - The ID of the campaign. - **sellerId** (string) - Required - The ID of the seller. - **startDate** (string) - Required - The start date for the report (YYYY-MM-DD). - **endDate** (string) - Required - The end date for the report (YYYY-MM-DD). ``` -------------------------------- ### Sample Budget Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns An example JSON response structure returned when querying for seller campaign budgets. ```json [ { "id": "6907877", "sellerId": "10624700", "campaignIds": [ 225662 ], "budgetType": "Daily", "amount": 12.0000, "startDate": "2021-02-25", "endDate": "Never", "spend": null, "status": "Current", "isSuspended": false } ] ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} Source: https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-single-seller-campaign-via-mpo Retrieves details for a specific budget by its ID. ```APIDOC ## GET /marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} ### Description Get a specific budget by its unique identifier. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} ### Parameters #### Path Parameters - **budgetId** (string) - Required - The unique identifier of the budget. ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/budgets Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-budgets Retrieves a list of budgets, with optional filtering parameters. ```APIDOC ## GET https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/budgets ### Description Retrieves a list of budgets associated with the account. You can filter the results using various query parameters. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/budgets ### Parameters #### Query Parameters - **advertiserId** (integer) - Optional - Return only budgets that pay for a given advertiser. - **campaignId** (integer) - Optional - Return only budgets that pay for a given campaign. - **sellerId** (string) - Optional - Return only budgets belonging to the given seller. - **endAfterDate** (string) - Optional - Return budgets that end after the given date (yyyy-MM-DD). - **startBeforeDate** (string) - Optional - Return budgets that start on or before the given date (yyyy-MM-DD). - **status** (string) - Optional - Return only budgets with the given status (Archived, Current, Scheduled). - **type** (string) - Optional - Return only budgets of the given type (e.g., Capped). ### Response #### Success Response (200) - **id** (string) - Budget ID - **sellerId** (string) - Seller ID - **campaignIds** (array) - List of campaign IDs - **budgetType** (string) - Type of budget - **amount** (number) - Budget amount - **startDate** (string) - Start date - **endDate** (string) - End date - **spend** (number) - Amount already spent - **status** (string) - Current status - **isSuspended** (boolean) - Suspension status #### Response Example [ { "id": "101", "sellerId": "1", "campaignIds": ["10001"], "budgetType": "Capped", "amount": 30.00, "startDate": "2019-05-01", "endDate": "2019-05-31", "spend": 0, "status": "Scheduled", "isSuspended": false } ] ``` -------------------------------- ### Create Product Set Request Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Example JSON request body for creating a product set with specific data set ID, name, and filtering rules. ```json { "data": { "type": "CreateProductSetRequest", "attributes": { "datasetId": "782", "name": "Product set name", "isDraft": True, "rules": [ { "operator": "IsIn", "field": "Category1", "values": [ "Decoration", "Home", "Furniture" ] }, { "operator": "IsNotIn", "field": "Category2", "values": [ "Games", "Gastronomy" ] }, { "operator": "IsIn", "field": "Brand", "values": [ "ADIDAS PERFORMANCE", "TEDDY SMITH", "REDSKINS", "NATACHA B", "GALERIES LAFAYETTE" ] }, { "operator": "Between", "field": "SalePrice", "values": ["1.2", "645531.56"] }, { "operator": "LessThan", "field": "SalePrice", "values": ["645531.56"] }, { "operator": "GreaterThan", "field": "RetailPrice", "values": ["1.2"] }, { "operator": "IsNotIn", "field": "ExternalItemId", "values": ["552751852", "550853326"] }, { "operator": "IsNotIn", "field": "CustomLabel0", "values": ["552751852", "550853326"] } ] } } } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId} Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns Retrieves the details of a specific Seller-Campaign by its ID. ```APIDOC ## GET /marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId} ### Description Retrieves the details of a specific Seller-Campaign by its ID. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId} ### Parameters #### Path Parameters - **sellerCampaignId** (string) - Required - The unique identifier of the seller campaign ### Response #### Success Response (200) - **id** (string) - Unique identifier of the seller campaign - **sellerId** (string) - Identifier of the seller - **campaignId** (integer) - Identifier of the campaign - **bid** (number) - Current bid value - **suspendedSince** (string) - Timestamp when the campaign was suspended - **suspensionReasons** (array) - List of reasons for suspension #### Response Example { "id": "543210.123456", "sellerId": "543210", "campaignId": 123456, "bid": 1.55, "suspendedSince": "2018-07-30T15:15:24.813", "suspensionReasons": [ "NoMoreBudget" ] } ``` -------------------------------- ### GET /marketplace-performance-outcomes/sellers Source: https://developers.criteo.com/marketing-solutions/docs/onboarding-to-mpo Retrieves a list of all sellers available in the MPO system. ```APIDOC ## GET /marketplace-performance-outcomes/sellers ### Description Retrieves a list of all sellers available in the MPO system. ### Method GET ### Endpoint /marketplace-performance-outcomes/sellers ``` -------------------------------- ### GET /marketplace-performance-outcomes/budgets Source: https://developers.criteo.com/marketing-solutions/docs/managing-budgets Retrieves the current budget for a specific seller and campaign. ```APIDOC ## GET /marketplace-performance-outcomes/budgets ### Description Retrieves the current budget details for a given seller and campaign. ### Method GET ### Endpoint /marketplace-performance-outcomes/budgets ### Parameters #### Query Parameters - **sellerId** (string) - Required - The ID of the seller. - **campaignId** (string) - Required - The ID of the campaign. ``` -------------------------------- ### Inspect productSet configuration Source: https://developers.criteo.com/marketing-solutions/docs/single-seller-campaigns Retrieves the current productSet status and rules for a Single-Seller campaign. ```json { "data": [ { "id": "SELLER_123.TEMPLATE_CAMPAIGN_456", "sellerId": "SELLER_123", "campaignId": "TEMPLATE_CAMPAIGN_456", "productSet": { "rules": [ { "operator": "IsIn", "field": "ExternalItemId", "values": [ "SKU_1", "SKU_2", "SKU_3" ] } ], "productSetStatus": "Valid", "productSetNumberOfProducts": 3 } } ] } ``` -------------------------------- ### GET /marketplace-performance-outcomes/budgets/{budgetId} Source: https://developers.criteo.com/marketing-solutions/docs/managing-budgets Retrieves details for a specific budget by its ID. ```APIDOC ## GET /marketplace-performance-outcomes/budgets/{budgetId} ### Description Retrieves the details of a specific budget to synchronize state or debug. ### Method GET ### Endpoint /marketplace-performance-outcomes/budgets/{budgetId} ### Parameters #### Path Parameters - **budgetId** (string) - Required - The unique identifier of the budget. ``` -------------------------------- ### GET /ads/{adId} Source: https://developers.criteo.com/marketing-solutions/docs/ads Retrieves details for a specific ad by its ID. ```APIDOC ## GET /ads/{adId} ### Description Retrieves the details of a specific ad created through the Criteo API. ### Method GET ### Endpoint /ads/{adId} ### Parameters #### Path Parameters - **adId** (string) - Required - The ID of the ad. ### Response #### Success Response (200) - **data** (object) - Ad object containing id, type, and attributes (name, description, creativeId, adSetId, startDate, endDate). - **warnings** (array) - List of warnings. - **errors** (array) - List of errors. #### Response Example { "data": { "id": "15", "type": "Ad", "attributes": { "name": "My first ad", "description": "Description of my first ad", "creativeId": "18", "adSetId": "345", "startDate": "2021-09-08T08:47:30.000Z", "endDate": "2021-10-08T08:47:30.000Z" } }, "warnings": [], "errors": [] } ``` -------------------------------- ### Seller-Campaign Response Fragment Source: https://developers.criteo.com/marketing-solutions/docs/quick-start-launch-a-single-seller-campaign-via-mpo Example JSON response containing the seller-campaign ID and current product set status. ```json [ { "id": "SELLER_123.TEMPLATE_CAMPAIGN_456", "sellerId": "123", "campaignId": "456", "productSet": null } ] ``` -------------------------------- ### POST /preview/product-sets Source: https://developers.criteo.com/marketing-solutions/docs/product-sets Creates a new product set for a specific advertiser by providing the dataset ID, name, draft status, and product rules. ```APIDOC ## POST /preview/product-sets ### Description Creates a new product set for a specific advertiser. ### Method POST ### Endpoint https://api.criteo.com/preview/product-sets ### Request Body - **data** (object) - Required - The request payload containing the product set attributes. - **type** (string) - Required - Must be "CreateProductSetRequest". - **attributes** (object) - Required - The attributes of the product set. - **datasetId** (string) - Required - The ID of the data set. - **name** (string) - Required - The name of the product set. - **isDraft** (boolean) - Optional - Indicates if the product set is a draft. - **rules** (array) - Required - A list of rules defining the product set. ### Request Example { "data": { "type": "CreateProductSetRequest", "attributes": { "datasetId": "782", "name": "Product set name", "isDraft": true, "rules": [ { "operator": "IsIn", "field": "Category1", "values": ["Decoration", "Home", "Furniture"] } ] } } } ### Response #### Success Response (200) - **data** (object) - The created product set object. - **warnings** (array) - List of warnings. - **errors** (array) - List of errors. #### Response Example { "data": { "attributes": { "datasetId": "string", "name": "string", "status": "Unknown", "isEnabled": true, "numberOfProducts": 0, "creationDate": "string", "rules": [ { "operator": "IsIn", "field": "Category1", "values": ["string"] } ], "id": "string" }, "id": "string", "type": "string" }, "warnings": [], "errors": [] } ``` -------------------------------- ### Campaign Search Response Source: https://developers.criteo.com/marketing-solutions/docs/campaign Example response structure returned when searching for campaigns. ```json { "data": [ { "type": "Campaign", "id": "99999", "attributes": { "name": "My Campaign", "advertiserId": "12345", "goal": "Retention", "spendLimit": { "spendLimitType": "capped", "spendLimitRenewal": "daily", "spendLimitAmount": 123.45 }, "budgetAutomation": { "enabled": true, "automatedBudgetConfiguration": { "adSetOptimizationObjective": "conversions" } } } } ], "errors": [] } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-budgets Fetches the details of a single budget by its unique identifier. ```APIDOC ## GET /marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} ### Description Fetches the details of a single budget using the specified budget ID. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId} ### Parameters #### Path Parameters - **budgetId** (string) - Required - The unique identifier of the budget. ### Response #### Success Response (200) - **id** (string) - The budget ID. - **sellerId** (string) - The seller ID associated with the budget. - **campaignIds** (array) - List of campaign IDs. - **budgetType** (string) - The type of budget (e.g., Capped). - **amount** (number) - The budget amount. - **startDate** (string) - The start date of the budget. - **endDate** (string) - The end date of the budget. - **spend** (number) - The current spend amount. - **status** (string) - The status of the budget. - **isSuspended** (boolean) - Indicates if the budget is suspended. #### Response Example { "id": "1759183", "sellerId": "321392", "campaignIds": [ 143962 ], "budgetType": "Capped", "amount": 1000, "startDate": "2021-01-11", "endDate": "2021-01-12", "spend": null, "status": "Active", "isSuspended": false } ``` -------------------------------- ### GET /creatives/{creativeId} Source: https://developers.criteo.com/marketing-solutions/docs/creative Retrieves the details of a specific creative by its unique ID. ```APIDOC ## GET /creatives/{creativeId} ### Description Retrieves the ID, format, and specific attributes for a single creative identified by its ID. ### Method GET ### Endpoint /creatives/{creativeId} ### Parameters #### Path Parameters - **creativeId** (string) - Required - The unique identifier of the creative. ### Response #### Success Response (200) - **data** (object) - The creative object containing attributes. - **errors** (array) - List of errors if any. - **warnings** (array) - List of warnings if any. ``` -------------------------------- ### Seller-Campaign Bid Response Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-campaigns Example response showing the structure of seller-campaign IDs and their associated bid values. ```json [{ "id": "1.10001", "bid": 0.3 },{ "id": "2.10001", "bid": 0.6 },{ "id": "3.10001", "bid": 0.5 }] ``` -------------------------------- ### Request Placement Report JSON Source: https://developers.criteo.com/marketing-solutions/docs/placement Example POST request body for retrieving a placement report. Requires specific attributes like advertiserIds, dates, and dimensions. ```json { "data": [{ "type": "ReportOrder", "attributes": { "advertiserIds": "22, 4949", "startDate": "2020-11-04", "endDate": "2020-11-04", "format": "json", "timezone": "Asia/Tokyo", "currency": "JPY", "dimensions": ["advertiserId", "adSetId", "placement"], "metrics": ["displays", "cost"] } }] } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId} Source: https://developers.criteo.com/marketing-solutions/docs/multiseller-managing-sellers Fetches the details of a single seller by their unique identifier. ```APIDOC ## GET /marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId} ### Description Fetches the details of a single seller using their unique identifier. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId} ### Parameters #### Path Parameters - **sellerId** (string) - Required - The unique identifier of the seller. ### Response #### Success Response (200) - **id** (string) - The seller ID. - **sellerName** (string) - The name of the seller. #### Response Example { "id": "123456", "sellerName": "HBogart" } ``` -------------------------------- ### GET /marketing-solutions/marketplace-performance-outcomes/stats/campaigns Source: https://developers.criteo.com/marketing-solutions/docs/mpo-standard-reporting-api Retrieves performance statistics aggregated per campaign over time. ```APIDOC ## GET https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/stats/campaigns ### Description Retrieves performance statistics aggregated per campaign over time. This is suitable for Multi-Seller MPO campaigns or template/single-seller campaigns at the campaign ID level. ### Method GET ### Endpoint https://api.criteo.com/{version}/marketing-solutions/marketplace-performance-outcomes/stats/campaigns ### Parameters #### Query Parameters - **advertiserId** (integer) - Optional - Restrict to a specific advertiser. - **campaignId** (string) - Optional - Restrict to one campaign. - **startDate** (string) - Optional - Start date for the report. - **endDate** (string) - Optional - End date for the report. - **intervalSize** (string) - Optional - Size of the time interval. - **count** (integer) - Optional - Number of records. - **clickAttributionPolicy** (string) - Optional - Attribution policy for clicks. ### Response #### Success Response (200) - **columns** (array) - List of column names in the data. - **data** (array) - The performance data rows. - **rows** (integer) - Total number of rows returned. ``` -------------------------------- ### Placement Category Response Example Source: https://developers.criteo.com/marketing-solutions/docs/placement-category Sample JSON response structure containing performance metrics per advertiser and category. ```json [ { "advertiserId": 123, "category": "News", "domain": "example.com", "displays": 42, "clicks": 12, "salesPc30d":5, "salesPv1d": 1 }, { "advertiserId": 456, "category": "News", "domain": "example.com", "displays": 42, "clicks": 12, "salesPc30d":5, "salesPv1d": 1 }, { "advertiserId": 789, "category": "News", "domain": "example.com", "displays": 42,, "clicks": 12, "salesPc30d":5, "salesPv1d": 1 } ] ``` -------------------------------- ### GET /marketplace-performance-outcomes/sellers/{sellerId}/budgets Source: https://developers.criteo.com/marketing-solutions/docs/onboarding-to-mpo Retrieves budget information for a specific seller. ```APIDOC ## GET /marketplace-performance-outcomes/sellers/{sellerId}/budgets ### Description Retrieves budget information for a specific seller. ### Method GET ### Endpoint /marketplace-performance-outcomes/sellers/{sellerId}/budgets ### Parameters #### Path Parameters - **sellerId** (string) - Required - The unique identifier for the seller generated by Criteo. ``` -------------------------------- ### GET /marketplace-performance-outcomes/sellers/{sellerId} Source: https://developers.criteo.com/marketing-solutions/docs/onboarding-to-mpo Retrieves details for a specific seller by their MPO-generated sellerId. ```APIDOC ## GET /marketplace-performance-outcomes/sellers/{sellerId} ### Description Retrieves details for a specific seller by their MPO-generated sellerId. ### Method GET ### Endpoint /marketplace-performance-outcomes/sellers/{sellerId} ### Parameters #### Path Parameters - **sellerId** (string) - Required - The unique identifier for the seller generated by Criteo. ```