HookLogic (Criteo) Balance 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 Balance. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
8 operations
across 6 paths,
and defines 25 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.
8 operations6 paths25 schemas4 GET1 PATCH3 POST
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
1
Authentication & Security 1
HookLogic (Criteo) Balance 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 8
Across 6 paths, the API surfaces 8 operations — 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are BalanceResponseV2 (14 properties), CommonProblem (9 properties), CreateBalanceV2 (7 properties), PageMetadata (6 properties). Each schema is shown below with its type and property counts.
ResourceOfBalanceResponseV2
object
A class that represents a domain entity exposed by an API
3 properties
ResourceOfBalanceCampaign202110
object
A class that represents a domain entity exposed by an API
3 properties
Metadata
object
Metadata related to the current request.
3 properties2 required
BalanceCampaign202110
object
Campaigns related to the balance
BalanceResponseV2PagedListResponse
object
Data model for a paged list of response resources
4 properties
CreateBalanceV2Request
object
A top-level object that encapsulates a Criteo API request for a single entity
1 property
CommonProblem
object
Common problem object.
9 properties
ResourceOfAddFundsToBalanceV2
object
A class that represents a domain entity exposed by an API
3 properties
UpdateBalanceModelV2Request
object
A top-level object that encapsulates a Criteo API request for a single entity
1 property
ResourceOfChangeDatesOfBalanceV2
object
A class that represents a domain entity exposed by an API
3 properties
PageOfBalanceHistoryChangeDataCaptureV1
object
A wrapper class to return a single page of items with metadata for offset and limit based paging.
2 properties2 required
ResourceOfCreateBalanceV2
object
A class that represents a domain entity exposed by an API
3 properties
AddFundsToBalanceV2
object
An object that represents the available options of adding funds to a balance.
3 properties1 required
BalanceResponseV2Response
object
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
BalanceHistoryChangeDataCaptureV1
object
Data model represents the data change capture of balance history.
5 properties4 required
ChangeDatesOfBalanceV2Request
object
A top-level object that encapsulates a Criteo API request for a single entity
1 property
AddFundsToBalanceV2Request
object
A top-level object that encapsulates a Criteo API request for a single entity
1 property
ChangeDatesOfBalanceV2
object
An object that represents the available options to modify schedule of a balance.
3 properties
PageMetadata
object
Metadata related to the current request
6 properties2 required
CreateBalanceV2
object
An object that represents the available options to set when creating a Retail Media Balance
7 properties3 required
ResourceOfUpdateBalanceModelV2
object
A class that represents a domain entity exposed by an API
3 properties
BalanceResponseV2
object
A Retail Media Balance used to determine the funds available for any or all campaigns in an account
14 properties5 required
UpdateBalanceModelV2
object
An object that represents the available options to set when updating a Retail Media Balance.
5 properties
BalanceCampaign202110PagedListResponse
object
Data model for a paged list of response resources
4 properties
ChangeDetailsV1
object
Change details of a property of the balance.
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
