HookLogic (Criteo) Campaign API

The Campaign API from HookLogic (Criteo) — 54 operation(s) for campaign.

Documentation Provider Profile APIs.io OpenAPI GitHub

HookLogic (Criteo) Campaign API is one of 8 APIs that HookLogic (Criteo) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaign. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 68 operations across 54 paths, and defines 218 schemas. It is described by OpenAPI 3.0.1, at version 2026-07.

Requests are made against a single base URL, https://api.criteo.com.

68 operations 54 paths 218 schemas 28 GET30 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

2026-07

Base URL

https://api.criteo.com

Authentication

OAuth 2.0

Resource Areas

Authentication & Security 1

HookLogic (Criteo) Campaign API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the clientCredentials and authorizationCode flows. By default, every request must be authenticated.

Paths & Operations 68

Across 54 paths, the API surfaces 68 operations — 28 GET, 30 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaign 68

GET

/2026-07/retail-media/accounts/{account-id}/campaigns

GetCampaignsByAccountId 4 params → 200

POST

/2026-07/retail-media/accounts/{account-id}/campaigns

CreateCampaignsByAccountId 1 param body → 201

GET

/2026-07/retail-media/accounts/{account-id}/creatives

GetAccountCreatives 1 param → 200

POST

/2026-07/retail-media/accounts/{account-id}/creatives

CreateCreative 1 param body → 201

GET

/2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}

GetCreative 2 params → 200

PUT

/2026-07/retail-media/accounts/{account-id}/creatives/{creative-id}

UpdateCreative 2 params body → 201

POST

/2026-07/retail-media/accounts/{account-id}/creatives/search

SearchAccountCreatives 2 params → 200

GET

/2026-07/retail-media/accounts/{account-id}/keywords/in-review-report

GetKeywordInReviewReport 3 params → 200

GET

/2026-07/retail-media/accounts/{account-id}/line-items

GetLineItemsByAccountId 6 params → 200

POST

/2026-07/retail-media/accounts/{accountId}/brand-catalog-export

CreateBrandCatalogExport 1 param body → 200

GET

/2026-07/retail-media/accounts/{accountId}/brands

GetBrandsByAccountId 4 params → 200

POST

/2026-07/retail-media/accounts/{accountId}/catalogs

CatalogApi_PostApiV1ExternalAccountCatalogsByAccountId 1 param body → 200

POST

/2026-07/retail-media/accounts/{accountId}/catalogs/sellers

Catalog_PostApiExternalV1AccountCatalogsSellersByAccountId 1 param body → 200

POST

/2026-07/retail-media/accounts/{accountId}/retailers/search

SearchAccountRetailers 3 params body → 200

POST

/2026-07/retail-media/accounts/{accountId}/seller-catalog-export

CreateSellerCatalogExport 1 param body → 200

POST

/2026-07/retail-media/assets

CreateAsset body → 201

GET

/2026-07/retail-media/auction-line-items/{lineItemId}

GetAuctionLineItem 1 param → 200

PUT

/2026-07/retail-media/auction-line-items/{lineItemId}

UpdateAuctionLineItem 1 param body → 200

POST

/2026-07/retail-media/balances/{balance-id}/campaigns/append

AppendCampaignsByBalanceId 1 param body → 200

POST

/2026-07/retail-media/balances/{balance-id}/campaigns/delete

DeleteCampaignsByBalanceId 1 param body → 200

GET

/2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items

GetPreferredLineItemsByCampaignId 4 params → 200

POST

/2026-07/retail-media/campaigns/{campaign-id}/preferred-line-items

CreatePreferredLineItemByCampaignId 1 param body → 201

GET

/2026-07/retail-media/campaigns/{campaignId}

GetCampaignByCampaignId 1 param → 200

PUT

/2026-07/retail-media/campaigns/{campaignId}

UpdateCampaignByCampaignId 1 param body → 200

GET

/2026-07/retail-media/campaigns/{campaignId}/auction-line-items

GetAuctionLineItemsByCampaign 4 params → 200

POST

/2026-07/retail-media/campaigns/{campaignId}/auction-line-items

CreateAuctionLineItem 1 param body → 201

GET

/2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides

GetCampaignBudgetOverrides 1 param → 200

PUT

/2026-07/retail-media/campaigns/{campaignId}/campaign-budget-overrides

UpdateCampaignBudgetOverrides 1 param body → 201

GET

/2026-07/retail-media/catalogs/{catalogId}/output

GetCatalogOutput 1 param → 200204

GET

/2026-07/retail-media/catalogs/{catalogId}/status

GetCatalogStatus 1 param → 200

GET

/2026-07/retail-media/categories

CategorySearch_GetApiExternalV1Categories 4 params → 200

GET

/2026-07/retail-media/categories/{categoryId}

GetCategory 1 param → 200

GET

/2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommendeddeprecated

/2026-07/retail-media/line-items/{externalLineItemId}/keywords/recommended

GetRecommendedKeywords 1 param → 200

GET

/2026-07/retail-media/line-items/{id}/keywords

FetchKeywords 1 param → 200

POST

/2026-07/retail-media/line-items/{id}/keywords/add-remove

AddRemoveKeywords 1 param body → 200

POST

/2026-07/retail-media/line-items/{id}/keywords/set-bid

SetKeywordBids 1 param body → 200

GET

/2026-07/retail-media/line-items/{line-item-id}

GetLineItemsByCampaignId 1 param → 200

GET

/2026-07/retail-media/line-items/{line-item-id}/bid-multipliers

GetBidMultipliersByLineItemId 1 param → 200

PUT

/2026-07/retail-media/line-items/{line-item-id}/bid-multipliers

UpdateBidMultipliersByLineItemId 1 param body → 200

POST

/2026-07/retail-media/line-items/{line-item-id}/keywords/review

UpdateKeywordReviews 1 param body → 200

GET

/2026-07/retail-media/line-items/{line-item-id}/products

FetchPromotedProducts 4 params → 200

POST

/2026-07/retail-media/line-items/{line-item-id}/products/append

AppendPromotedProducts 1 param body → 200204

POST

/2026-07/retail-media/line-items/{line-item-id}/products/delete

DeletePromotedProducts 1 param body → 204

POST

/2026-07/retail-media/line-items/{line-item-id}/products/pause

PausePromotedProducts 1 param body → 204

POST

/2026-07/retail-media/line-items/{line-item-id}/products/unpause

UnpausePromotedProducts 1 param body → 204

GET

/2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides

GetLineItemBudgetOverrides 1 param → 200

PUT

/2026-07/retail-media/line-items/{lineItemId}/line-item-budget-overrides

UpdateLineItemBudgetOverrides 1 param body → 201

GET

/2026-07/retail-media/preferred-line-items/{line-item-id}

GetPreferredLineItemsByLineItemId 1 param → 200

PUT

/2026-07/retail-media/preferred-line-items/{line-item-id}

UpdatePreferredLineItemByLineItemId 1 param body → 200

GET

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket

GetAddToBasketTargetsByLineItemId 1 param → 200

PUT

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket

PutAddToBasketTargetByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/append

AppendAddToBasketTargetsByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/add-to-basket/delete

DeleteAddToBasketTargetsByLineItemId 1 param body → 200

GET

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences

GetAudienceTargetsByLineItemId 1 param → 200

PUT

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences

PutAudienceTargetsByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/append

AppendAudienceTargetsByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/audiences/delete

DeleteAudienceTargetsByLineItemId 1 param body → 200

GET

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores

GetStoreTargetsByLineItemId 1 param → 200

PUT

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores

PutStoreTargetByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/append

AppendStoreTargetsByLineItemId 1 param body → 200

POST

/2026-07/retail-media/preferred-line-items/{line-item-id}/targeting/stores/delete

DeleteStoreTargetByLineItemId 1 param body → 200

GET

/2026-07/retail-media/retailers/{retailer-id}/templates

GetRetailerCreativeTemplates 1 param → 200

GET

/2026-07/retail-media/retailers/{retailer-id}/templates/{template-id}

GetCreativeTemplate 2 params → 200

POST

/2026-07/retail-media/retailers/{retailerId}/categories/search

SearchCategory 3 params body → 200

POST

/2026-07/retail-media/retailers/{retailerId}/cpc-min-bids

GetCpcMinBidsBySkuIdsV1 1 param body → 200

GET

/2026-07/retail-media/retailers/{retailerId}/pages

RetailerApi_GetApi202110ExternalRetailerPagesByRetailerId 1 param → 200

POST

/2026-07/retail-media/retailers/{retailerId}/recommend-categories

GetRecommendedCategories 1 param body → 200

POST

/2026-07/retail-media/retailers/{retailerId}/recommend-keywords

RecommendedKeywords 1 param body → 200

Schemas 218

The contract defines 218 schemas that model the data the API accepts and returns. The most detailed are CampaignV202301 (23 properties), SponsoredProductsLineItem (20 properties), CampaignAttributesV202301 (16 properties), PreferredLineItemV2 (16 properties). Each schema is shown below with its type and property counts.

ValueResourceOfSponsoredProductsLineItemCreateRequestModel

object

A value resource exposed by the API.

2 properties

JsonApiRequestOfSellerCatalogRequest

object

A JSON:API wrapper class to format a with Type, and Attributes properties

1 property

InputKeywords

object

Keywords submitted by the user binned by type after some cleanup has been performed

3 properties

AudienceTarget202110

object

Identifies audience targeting for a line item

2 properties 2 required

InputResourceOfPreferredLineItemCreateModelV2

object

Data model for a Resource

2 properties

JsonApiBodyWithIdOfInt64AndBrandAndBrand

object

A JSON:API wrapper class to format a with external Id, Type, and Attributes properties

3 properties 2 required

Metadata

object

Metadata related to the current request.

3 properties 2 required

FlightSchedule

object

A flight schedule for a line item.

1 property

CampaignAvailabilityV2

object

Information about the budget model availability for a specific campaign type and buy type combination, and page types and environments supported for that combi…

4 properties

CommonProblem

object

Common problem object.

9 properties

PromotedProduct

object

A promoted product.

3 properties

JsonApiSingleResponseOfCampaignV202301

object

A JSON:API wrapper class to add one JSON:API within a data property

3 properties 1 required

PreferredLineItemV2

object

A Retail Media Preferred Line Item used to hold bid settings for one or many promoted products on a single retailer

16 properties 6 required

Category202204ListResponse

object

A top-level object that encapsulates a Criteo API response for several entities.

3 properties

SellerCatalogRequestV2

object

Used to request a catalog of seller SKUs

3 properties

SellerCatalogRequest

object

Used to request a catalog of seller SKUs

1 property 1 required

RecommendedKeywordsResponseV1

object

Response model of Recommended Keywords

1 property 1 required

SponsoredProductsLineItemCreateRequestModel

object

Model to create a retail media auction line item

14 properties 3 required

BrandCatalogRequestV2

object

A request for a catalog under the specified format.

4 properties

ValueResourceCpcMinBidsResponse

object

A value resource exposed by the API.

2 properties

LineItemPageCategoryV2

object

Category information for a preferred line item page

2 properties 1 required

EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata

object

A top-level object that encapsulates a Criteo API response for several entities and metadata.

4 properties

FilesVariableValue

object

A value of a template file variable (one or several files), like images in a creative

1 property 1 required

ValueResourceCpcMinBidsRequest

object

A value resource exposed by the API.

2 properties

JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301

object

A JSON:API wrapper class to format a with Id, Type, and Attributes properties

3 properties 2 required

LineItemPageV2

object

Page information for a preferred line item

3 properties 1 required

SetBidModel

object

A single keyword and associated bid override

2 properties

AudienceTarget202110Request

object

Data model for a value type input resource

1 property

LineItemProductStatus

string

The status of a promoted product in the context of the line item.

Template

object

A template for creating creatives.

12 properties 8 required

JsonApiPageResponseOfCampaignV202301

object

A wrapper class to return a single page of with metadata

4 properties 2 required

ValueTypeResourceOfAudienceTarget202110

object

Data model for a value type resource

2 properties

KeywordDataModel

object

A single keyword and associated bid override.

6 properties

JsonApiSingleResponseOfCatalogStatus

object

A JSON:API wrapper class to add one JSON:API within a data property

3 properties 1 required

JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301

object

A JSON:API wrapper class to format a with Type, and Attributes properties

2 properties 1 required

ValueTypeResourceOfStoreTarget202110

object

Data model for a value type resource

2 properties

Category202204

object

List of retailer's categories, including the full hierarchy of categories and their parent category ID

3 properties 3 required

CommonLineItemPagedListResponse

object

Data model for a paged list of response resources

4 properties

LineItemBidMultipliersV2Response

object

A top-level object that encapsulates a Criteo API response for a single entity

3 properties

CampaignV202301

object

A Retail Media Campaign used to represent an advertiser's marketing objective

23 properties 5 required

PreferredLineItemV2PagedListResponse

object

Data model for a paged list of response resources

4 properties

ValueResourceOutcomeRetailMediaKeywordsReviewResult

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

ValueResourceOutcomeOfRecommendedKeywordsResult

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

Creative202210Response

object

A top-level object that encapsulates a Criteo API response for a single entity.

3 properties

LineItemKeywordReviewReport

object

Reports on a line item which contains one or more actionable keyword reviews

9 properties 9 required

StoreTarget202110

object

Identifies store targeting for a line item

2 properties 2 required

EntityResourceCollectionOutcomeCategory202204

object

A top-level object that encapsulates a Criteo API response for several entities.

3 properties

KeywordsModel

object

The keywords associated with a line item.

2 properties

ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest

object

A JSON:API wrapper class to format a with Type, and Attributes properties

2 properties 1 required

ValueResourceOfSponsoredProductsLineItemUpdateRequestModel

object

A value resource exposed by the API.

2 properties

ResourceOutcome

object

Outcome object containing errors and warnings.

2 properties

StoreIdsUpdateModel202110Request

object

Data model for a value type input resource

1 property

CampaignMonthlyBudgetOverride

object

Campaign monthly budget override.

4 properties 2 required

ValueResourceInputRecommendedCategoriesRequestV1

object

A top-level object that encapsulates a Criteo API request for a single value objects.

1 property

TemplateResponse

object

A top-level object that encapsulates a Criteo API response for a single entity.

3 properties

ValueResourceInputOfBrandCatalogRequestV2

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

TemplateVariable

object

A variable in a creative template

6 properties 3 required

FilesVariablesSpecification

object

Specification of a file variable

4 properties 1 required

SponsoredProductsLineItem

object

Model of a retail media auction line item.

20 properties 7 required

SellerIdentifier

object

Identifies a Unique Seller

2 properties 2 required

BalanceCampaign202110PagedListResponse

object

Data model for a paged list of response resources

4 properties

EditableCampaignAttributesV202301

object

An object that represents the available options to set when editing a Retail Media Campaign

13 properties 4 required

ExternalCatalogStatus

object

The status of an asynchronous request to generate a catalog

7 properties 7 required

SellerIdentifierV2

object

Identifies a Unique Seller

2 properties 2 required

RmcaCommonProblem

object

Common problem object.

9 properties

StoreTarget202110Request

object

Data model for a value type input resource

1 property

JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest

object

A JSON:API wrapper class to format a with Type, and Attributes properties

2 properties 1 required

ChoiceVariableSpecification

object

Specification of choice variable

3 properties 1 required

Asset

object

Handles pointing towards binary content that advertisers can use later on, for example in their creatives.

2 properties 1 required

AddRemoveKeywordsModelResource

object

Resource object containing keywords to be added or removed from a line item

3 properties

PromotedProductResourceCollectionOutcome

object

Outcome object containing promoted products.

4 properties

JsonApiBodyWithLineItemBidMultipliersV2

object

A JSON:API wrapper class to format a with Id, Type, and Attributes properties

2 properties 1 required

EntityResourceCategory202204

object

A domain entity exposed by the API, identified by a unique id.

3 properties

TextVariableValue

object

A value of a template text variable

1 property 1 required

ResourceOfBalanceCampaign202110

object

A class that represents a domain entity exposed by an API

3 properties

KeywordsModelResponse

object

Response object containing keywords associated with a line item.

3 properties

BalanceCampaign202110

object

Campaigns related to the balance

ValueResourceOfSellerCatalogRequestV2

object

A value resource exposed by the API.

2 properties

LineItemBidMultipliersV2

object

The Bid Multiplier Entity of a LineItem

12 properties

BalanceCampaign202110ListRequest

object

A top-level object that encapsulates a Criteo API request for several entities

1 property

Section

object

Section object that hold template variables

3 properties 1 required

ResourceOfTemplate

object

A class that represents a domain entity exposed by an API.

3 properties

ValueResourceOfBrandCatalogRequestV2

object

A value resource exposed by the API.

2 properties

ExternalBrand

object

A Retail Media Brand used to represent a collection of products sold under the same umbrella name

1 property 1 required

ReviewSetState

object

A Phrase-ReviewState pair describing an update to a keyword review

2 properties 2 required

ResourceOfCreative202210

object

A class that represents a domain entity exposed by an API.

3 properties

CommonLineItemResponse

object

A top-level object that encapsulates a Criteo API response for a single entity

3 properties

ProductResourceOutcome

object

Outcome object containing errors and warnings.

2 properties

ExternalCatalogRequest

object

A request for a catalog under the specified format. Currently "json-newline" is supported.

2 properties

TemplateVariableValue

object

A value for a variable in a creative template.

7 properties 1 required

AddRemoveKeywordsModelRequest

object

Request object to add or remove keywords from a line item

1 property

EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata

object

A top-level object that encapsulates a Criteo API response for several entities and metadata.

4 properties

ResourceOfCreative2

object

A class that represents a domain entity exposed by an API.

3 properties

RetailMediaKeywordsReviewResult

object

Response object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs

1 property 1 required

AudienceTarget202110Response

object

Data model for a value type resource outcome

3 properties

ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

Creative202110

object

Metadata and usage info of a preferred deals creative

7 properties 3 required

ProductMetadata

object

Metadata about the response. Used for pagination.

4 properties

ValueResourceOutcomeCpcMinBidsResponse

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

CampaignDailyBudgetOverride

object

Campaign daily budget override.

4 properties 2 required

ValueResourceRecommendedKeywordsRequestV1

object

A value resource exposed by the API.

2 properties

KeywordsModelResource

object

Resource object containing keywords associated with a line item.

3 properties

PostCampaignV202301

object

An object that represents the available options to set when creating a Retail Media Campaign

1 property

ValueResourceOfCampaignBudgetOverrides

object

A value resource exposed by the API.

2 properties

PreferredLineItemCreateModelV2Request

object

Data model for a create input resource

1 property

RetailerSearchRequestV2

object

Request model for searching retailers

1 property

ReviewStateModel

string

The state of a keyword in the context of a line item.

PreferredLineItemCreateModelV2

object

Model used to create a preferred line item

10 properties 7 required

InputKeywordsModel

object

The keywords to be added or removed from a line item.

3 properties

AddRemoveKeywordsModel

object

Data model containing keywords to be added or removed from a line item

1 property

PreferredLineItemUpdateModelV2

object

Model used to update a preferred line item

9 properties 4 required

PromotedProductResource

object

Resource object containing a promoted product.

3 properties

AddToBasketTarget202110Response

object

Data model for a value type resource outcome

3 properties

PreferredLineItemV2Response

object

A top-level object that encapsulates a Criteo API response for a single entity

3 properties

CategoriesSearchRequestV1

object

An object that represents the request of CategoriesSearch endpoint.

2 properties

EntityResourceOutcomeOfSponsoredProductsLineItem

object

A top-level object that encapsulates a Criteo API response for a single entity.

3 properties

EntityResourceOfRetailerResultV2

object

A domain entity exposed by the API, identified by a unique id.

3 properties

AddToBasketIdsUpdateModel202110

object

Update model for updating add to basket target ids

2 properties

ResourceOfCategory202204

object

A class that represents a domain entity exposed by an API.

3 properties

PageTypeEnvironment2

object

The PageType-Environment Tuples for creatives

2 properties

RetailerResultV2

object

The result of a query for the configuration of a retailer

2 properties

ResourceOfPreferredLineItemV2

object

A class that represents a domain entity exposed by an API

3 properties

TextVariableSpecification

object

Specification of a text variable

1 property

EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata

object

A top-level object that encapsulates a Criteo API response for several entities and metadata.

4 properties

CampaignBudgetOverrides

object

Campaign budget overrides including Monthly and Daily budget overrides.

2 properties 2 required

JsonApiRequestOfCatalogRequest

object

A JSON:API wrapper class to format a with Type, and Attributes properties

1 property

StoreIdsUpdateModel202110

object

Update model for updating store target ids

1 property 1 required

LineItemBidMultipliersV2Request

object

A top-level object that encapsulates a Criteo API request for a single entity

1 property

TemplateListResponse

object

A top-level object that encapsulates a Criteo API response for several entities.

3 properties

AssetResource

object

A class that represents a domain entity exposed by an API

3 properties

ValueResourceInputCategoriesSearchRequestV1

object

A top-level object that encapsulates a Criteo API request for a single value objects.

1 property

ValueResourceOutcomeOfLineItemBudgetOverrides

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

Creative202110ListResponse

object

A top-level object that encapsulates a Criteo API response for several entities.

3 properties

ValueTypeResourceOfAddToBasketTarget202110

object

Data model for a value type resource

2 properties

Creative2ListResponse

object

A top-level object that encapsulates a Criteo API response for several entities.

3 properties

PageTypeEnvironment202210

object

The PageType-Environment Tuples for creatives

2 properties

StoreTarget202110Response

object

Data model for a value type resource outcome

3 properties

LineItemBudgetOverrides

object

Line item budget overrides including Monthly and Daily budget overrides.

2 properties 2 required

ValueResourceInputOfRetailerSearchRequestV2

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

EntityResourceLineItemKeywordReviewReport

object

A domain entity exposed by the API, identified by a unique id.

3 properties

RecommendedKeywordsRequestV1

object

Request model of RecommendedKeywords

1 property 1 required

AddToBasketTarget202110

object

Identifies add to basket targeting for a line item

3 properties 1 required

ChoiceOption

object

An option given in a choice

2 properties 2 required

AssetResponse

object

A top-level object that encapsulates a Criteo API response for a single entity

3 properties

SponsoredProductsLineItemUpdateRequestModel

object

A request to update a Sponsored Products Line Item.

13 properties 4 required

CreativeUpdateModel202207

object

Update model of a creative

6 properties 4 required

EntityResourceOfCatalogStatusV2

object

A domain entity exposed by the API, identified by a unique id.

3 properties

EntityResourceOutcomeOfCatalogStatusV2

object

A top-level object that encapsulates a Criteo API response for a single entity.

3 properties

PageMetadata

object

Metadata related to the current request

6 properties 2 required

PageTypeCombinationV2

object

Represents a combination of page type and page environment type for a specific campaign-buy type.

2 properties

CatalogStatusV2

object

The status of an asynchronous request to generate a catalog

6 properties 2 required

ValueResourceRecommendedCategoriesRequestV1

object

A value resource exposed by the API.

2 properties

JsonApiSingleResponseOfLineItemBidMultipliersV2

object

A JSON:API wrapper class to add one JSON:API within a data property

3 properties 1 required

AddToBasketTarget202110Request

object

Data model for a value type input resource

1 property

MonthlyLineItemBudegetOverride

object

The details for a monthly budget override

4 properties 2 required

RecommendedCategoriesRequestV1

object

An object that represents the request of RecommendCategories endpoint.

1 property 1 required

Creative202210

object

A creative entity

13 properties 9 required

Creative2

object

A creative entity

13 properties 9 required

ValueResourceOfRecommendedKeywordsResult

object

A value resource exposed by the API.

2 properties

EntityResourceOfSponsoredProductsLineItem

object

A domain entity exposed by the API, identified by a unique id.

3 properties

ChoiceVariableValue

object

A value of a template choice variable (among different accepted options)

1 property 1 required

ValueResourceInputOfSellerCatalogRequestV2

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

CpcMinBidsRequest

object

Cpc Min Bids request object.

1 property 1 required

ValueResourceInputCpcMinBidsRequest

object

A top-level object that encapsulates a Criteo API request for a single value objects.

1 property

CommonLineItem

object

A common line item to hold line item information shared between preferred and auction line items

13 properties 5 required

SkuMinBid

object

An object represents the minimum bid amount value of a sku.

2 properties 2 required

RetailerPages202110

object

Wraps a list of valid pages for a retailer

1 property 1 required

ColorVariableValue

object

A value of a template color variable

1 property 1 required

ValueResourceOutcomeOfCampaignBudgetOverrides

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

ValueResourceCategoriesSearchRequestV1

object

A value resource exposed by the API.

2 properties

ValueTypeResourceOfAudienceIdsUpdateModel202110

object

Data model for a value type resource

2 properties

ValueResourceRetailMediaKeywordsReviewResult

object

A value resource exposed by the API.

2 properties

AudienceIdsUpdateModel202110Request

object

Data model for a value type input resource

1 property

EntityResourceCollectionOutcomeCategory202204Metadata

object

A top-level object that encapsulates a Criteo API response for several entities and metadata.

4 properties

AudienceIdsUpdateModel202110

object

Update model for updating audience target ids

1 property 1 required

LineItemCappingV2

object

Frequency Capping for a Preferred Line Item

2 properties 2 required

ResourceOfCreative202110

object

A class that represents a domain entity exposed by an API.

3 properties

AddToBasketIdsUpdateModel202110Request

object

Data model for a value type input resource

1 property

PreferredLineItemUpdateModelV2Request

object

A top-level object that encapsulates a Criteo API request for a single entity

1 property

Creative2Response

object

A top-level object that encapsulates a Criteo API response for a single entity.

3 properties

ValueResourceOutcomeRecommendedKeywordsResponseV1

object

A top-level object that encapsulates a Criteo API response for a single value object.

3 properties

JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus

object

A JSON:API wrapper class to format a with external Id, Type, and Attributes properties

3 properties 2 required

ValueResourceInputOfLineItemBudgetOverrides

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

ValueResourceRetailMediaKeywordsReview

object

A value resource exposed by the API.

2 properties

RetailMediaKeywordsReview

object

Request object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs

1 property 1 required

SdkApiRestCommonProblem

object

Common problem object.

8 properties

ValueTypeResourceOfAddToBasketIdsUpdateModel202110

object

Data model for a value type resource

2 properties

ResourceOfCommonLineItem

object

A class that represents a domain entity exposed by an API

3 properties

SetBidsModelResource

object

Resource object containing keywords and their associated bid overrides

3 properties

RecommendedKeywordsResult

object

Response model for recommended keywords

2 properties

ResourceOfPreferredLineItemUpdateModelV2

object

A class that represents a domain entity exposed by an API

3 properties

ValueResourceOfLineItemBudgetOverrides

object

A value resource exposed by the API.

2 properties

AddRemoveKeywordModel

object

A single keyword to be added or removed

3 properties

ValueResourceInputOfCampaignBudgetOverrides

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

ResourceOfLineItemBidMultipliersV2

object

A class that represents a domain entity exposed by an API

3 properties

CommonError

object

A JSON:API Common error structure

8 properties

CommonWarning

object

A JSON:API Base common warning

8 properties

CreativeCreateModel202207

object

Create model of a creative

6 properties 4 required

HyperlinkVariableValue

object

A value of a template hyperlink variable

1 property 1 required

PutCampaignV202301

object

An object that represents the available options to set when editing a Retail Media Campaign

1 property

PromotedProductResourceCollectionInput

object

Request object containing promoted products to be appended, deleted, paused or unpaused.

1 property

VideoVariableValue

object

A value of a template video variable

4 properties 4 required

CpcMinBidsResponse

object

Cpc Min Bids response object.

2 properties 2 required

ValueResourceInputRetailMediaKeywordsReview

object

A top-level object that encapsulates a Criteo API request for a single value object.

1 property

Keywords

object

Data associated with a normalized keyword phrase

6 properties

JsonApiPageResponseOfBrand

object

A wrapper class to return a single page of with metadata

4 properties 2 required

CampaignAttributesV202301

object

An object that represents the available options to set when creating a Retail Media Campaign

16 properties 2 required

ValueResourceOfRetailerSearchRequestV2

object

A value resource exposed by the API.

2 properties

ValueResourceInputRecommendedKeywordsRequestV1

object

A top-level object that encapsulates a Criteo API request for a single value objects.

1 property

DailyLineItemBudgetOverride

object

The details for a daily budget override

4 properties 1 required

ValueResourceRecommendedKeywordsResponseV1

object

A value resource exposed by the API.

2 properties

SetBidsModelRequest

object

Request object to set bid overrides for keywords associated with a line item

1 property

MatchTypeModel

string

The match type of a keyword.

ValueTypeResourceOfStoreIdsUpdateModel202110

object

Data model for a value type resource

2 properties

FlightLeg

object

A leg of a flight schedule outlining which days and times the line item will run.

3 properties 3 required

SetBidsModel

object

Data model containing keywords and their associated bid overrides

1 property

JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301

object

A JSON:API wrapper class to format a with Id, Type, and Attributes properties

3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs HookLogic (Criteo) publishes across the network.

HookLogic (Criteo) Accounts API

AE Profile APIs.io

HookLogic (Criteo) Analytics API

AE Profile APIs.io

HookLogic (Criteo) Audience API

AE Profile APIs.io

HookLogic (Criteo) Balance API

AE Profile APIs.io

HookLogic (Criteo) Billing API

AE Profile APIs.io

HookLogic (Criteo) Catalog API

AE Profile APIs.io

HookLogic (Criteo) Gateway API

AE Profile APIs.io

#Campaign

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

HookLogic (Criteo) Campaign API

Metadata

Authentication & Security 1

Paths & Operations 68

Schemas 218

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

HookLogic (Criteo) Campaign API

Metadata

Authentication & Security 1

Paths & Operations 68

Schemas 218

Specification

Source

More from HookLogic (Criteo) 7

API Details

Provider

Explore more