Offsite Report
Introduction
Four separated endpoints support requests to create campaign and line item reports and retrieve the report data and status. You can find those endpoints in our stable version Demand Side Analytics.
The endpoints and functionalities covered in this page refers to features available exclusively in Preview for now, which doesn't mean that they are the only ones available for this domain/scope.
For more complete information about our API capabilities, check the Stable version in Welcome to Criteo Retail Media API
We added a "create an offsite report request", in the preview version that is described below.
Endpoints
Verb | Endpoint | Description |
---|---|---|
POST | /reports/offsite | Create an offsite report request |
Reporting Asynchronous Workflow
- First, create a request for the campaign or line item report with the desired attributes,
- This generates a
reportId
representing the report.- Next, use the
reportId
to poll the report status endpoint until one is successfully computed (available in stable - see above)- Finally, download the report using the report output endpoint (available in stable - see above)
- Report outputs are cached for at least 1 hour before expiration. Exact expiration is indicated by the
expiresAt
field in the /status response.
Report Request Attributes
Attribute | Data Type | Description |
---|---|---|
| string / | Campaign or Line Item ID(s) of the desired report Examples: Accepted values: single or list of string/int64 (max 50 ids per call) |
| enum | Report types are pre-packaged reports that allow the specification of the report breakdown. See Report Types for more details about each of them.
Accepted values: refer to Report Types page for a complete list of available values |
| list<enum> | Dimension attributes desired for metrics breakdown for the custom report of the campaign(s) / line item(s).
Accepted values: refer to Metrics and Dimensions page for a complete list of available values |
| list<enum> | Quantitative metrics desired in the custom report of the campaign(s) / line item(s).
Accepted values: refer to Metrics and Dimensions page for a complete list of available values |
| date | Start date to report (inclusive) Accepted values: |
| date | End date to report (inclusive) Accepted values: |
| enum | Campaign type Accepted values: |
| string | Time zone to consider in the report Accepted values: IANA (TZ database) time zones (example: |
| enum | The post-click attribution window, defined as the maximum number of days considered between a click and a conversion for attribution; conversions are attributed to the date of conversion, not the date of click; defaults to campaign settings if omitted; must be specified if The post-click attribution window, defined as the maximum number of days considered between a click and a conversion for attribution; conversions are attributed to the date of conversion, not the date of click. Accepted values: |
| enum | The post-view attribution window, defined as the maximum number of days considered between an impression and a conversion for attribution; conversions are attributed to the date of conversion, not the date of impression; defaults to campaign settings if omitted; must be less than or equal to The post-view attribution window, defined as the maximum number of days considered between an impression and a conversion for attribution; conversions are attributed to the date of conversion, not the date of impression. Accepted values: |
| enum | Filter on specific sales channel: online or offline Accepted values: |
| enum | Format of the report data returned Accepted values: |
(*) Required
Field Definitions
- Writeable (Y/N): Indicates if the field can be modified in requests.
- Nullable (Y/N): Indicates if the field can accept null/empty values.
- Primary Key: A unique, immutable identifier of the entity, generated internally by Criteo. Primary keys are typically ID fields (e.g.,
retailerId
,campaignId
,lineItemId
) and are usually required in the URL path.
Offsite Dimensions
Those dimensions are specific to offsite reports.
Report level and report types are not applicable for offsite reporting.
Dimension Name | Dimension Type | Description | Example |
---|---|---|---|
adFormatSize | Dimension | The format size of the placement ad, usually defined in width × height pixels. | 300x250 |
billingType | Dimension | The ad strategy billing type. Typically Cost Per Click (CPC) or Cost Per Mille (CPM). | CPC |
inventoryType | Dimension | Category of video ads not tied to video content. Seen in native feeds, slideshows, etc. | In-content |
mediaType | Dimension | The type of creative asset used in the ad, such as Display or Video. | Video |
publisher | Dimension | The domain of the publisher where the ad was rendered. | example.com |
ssp | Dimension | The Supply-Side Platform (SSP) responsible for the ad event. | Google Ad Manager |
Create an offsite report request
The dimensions specific to offsite reports can be found here.

https://api.criteo.com/`{version}`/retail-media/reports/offsite
Sample request
{
"data": {
"type": "string",
"attributes": {
"accountIds": [
"563116287072485376"
],
"dimensions": [
"date",
"daysDifference",
"advDate",
"advHour",
"campaignId",
"campaignName",
"lineItemId",
"lineItemName",
"retailerId",
"retailerName",
"billingType",
"environment",
"adFormatSize",
"ssp",
"publisher",
"inventoryType",
"mediaType",
"buyType",
"salesChannel",
"creativeId",
"creativeName"
],
"metrics": [
"audience",
"uniqueVisitors",
"reachRate",
"impressions",
"frequency",
"winRate",
"clicks",
"ctr",
"viewability",
"cpc",
"ecpm",
"cpm",
"spend",
"attributedUnits",
"attributedSales",
"roas",
"videoStarts",
"videosPlayedTo25",
"videosPlayedTo50",
"videosPlayedTo75",
"videosPlayedTo100",
"videoStartingRate",
"videoCompletionRate",
"videoCPC",
"videoCPCV",
"visits",
"qualifiedVisits",
"landingRate"
],
"format": "csv",
"clickAttributionWindow": "none",
"viewAttributionWindow": "none",
"startDate": "2025-06-18",
"endDate": "2025-06-19",
"timezone": "UTC"
}
}
}
Responses
Response | Description |
---|---|
🔵 | Call executed with success
When generating a report type using the |
🔴 | Common Validation Errors
|
🔴 | Validation Error In the API, win rate metric will be available to sponsored product campaigns only. When using this metric, please specify **"title": " "detail": "Please provide either the |
🔴 | Expired or Lost Report Error The report is expired, lost, or failed to create. Re-create the report through a new request. |
Updated about 19 hours ago