> ## Documentation Index
> Fetch the complete documentation index at: https://developers.criteo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# /2026-01/retail-media/reports/revenue
> Returns an asynchronous Revenue Report
This endpoint is subject to specific rate limits.
## OpenAPI
````yaml https://api.criteo.com/2026-01/retailmedia/open-api-specifications.json post /2026-01/retail-media/reports/revenue
openapi: 3.0.1
info:
title: Criteo API
description: Criteo API - RetailMedia
version: 2026-01
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Accounts
- name: Analytics
- name: Audience
- name: Balance
- name: Billing
- name: Campaign
- name: Gateway
paths:
/2026-01/retail-media/reports/revenue:
post:
tags:
- Analytics
summary: /2026-01/retail-media/reports/revenue
description: "Returns an asynchronous Revenue Report\r\n
\r\nThis endpoint is subject to specific rate limits."
operationId: GenerateAsyncRevenueReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncRevenueReportRequest'
required: true
x-bodyName: request
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncReportResponse'
security:
- oauth:
- RetailMedia_Analytics_Read
components:
schemas:
AsyncRevenueReportRequest:
type: object
properties:
data:
$ref: '#/components/schemas/AsyncRevenueReportResource'
description: >-
A top-level object that encapsulates a Criteo API request for a single
value
AsyncReportResponse:
type: object
properties:
data:
$ref: '#/components/schemas/StatusResponseResource'
errors:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
readOnly: true
warnings:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
readOnly: true
description: Async Report response format
AsyncRevenueReportResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/AsyncRevenueReport'
type:
type: string
description: >-
A top-level object that encapsulates a Criteo API response for a single
value
StatusResponseResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/StatusResponse'
id:
type: string
nullable: true
type:
type: string
nullable: true
description: A class that represents a domain entity exposed by an API
nullable: true
CommonProblem:
type: object
properties:
code:
type: string
description: A machine-readable error code, expressed as a string value.
nullable: true
detail:
type: string
description: >-
A human-readable explanation specific to this occurrence of the
problem
nullable: true
instance:
type: string
description: A URI that identifies the specific occurrence of the problem.
nullable: true
source:
type: object
additionalProperties:
type: string
description: >-
A machine-readable structure to reference to the exact location(s)
causing the error(s)
nullable: true
stackTrace:
type: string
nullable: true
title:
type: string
description: A short human-readable description of the problem type
nullable: true
traceId:
type: string
description: The request correlation ID this problem comes from.
nullable: true
traceIdentifier:
type: string
description: >-
The request correlation ID this problem comes from. (deprecated, use
traceId instead)
nullable: true
type:
enum:
- unknown
- access-control
- authentication
- authorization
- availability
- deprecation
- quota
- validation
type: string
description: The problem's category.
nullable: true
description: Common problem object.
AsyncRevenueReport:
required:
- endDate
- startDate
type: object
properties:
accountIds:
type: array
items:
type: string
description: Account ids to filter
activationPlatforms:
type: array
items:
enum:
- CommerceMax
- PrivateMarket
type: string
description: 'Filter on the activation platform: CommerceMax, PrivateMarket'
advertiserTypes:
type: array
items:
enum:
- retailer
- brand
- seller
type: string
description: 'Filter on the type of advertiser: retailer, brand, seller'
budgetModels:
type: array
items:
enum:
- CriteoBudget
- RetailerBudget
type: string
description: 'Filter on the budget model: CriteoBudget, RetailerBudget'
buyType:
enum:
- auction
- preferredDeals
- sponsorship
type: string
description: 'Filter on buy type: Auction, Preferred Deals or Sponsorship'
campaignIds:
type: array
items:
type: string
description: Campaign ids to filter
campaignType:
enum:
- all
- sponsoredProducts
- onSiteDisplays
type: string
description: >-
Filter the type of campaigns to report on: sponsoredProducts or
onSiteDisplays
default: all
clickAttributionWindow:
enum:
- none
- 7D
- 14D
- 30D
type: string
description: Click attribution window
default: none
clickMatchLevel:
enum:
- sameSku
- sameCategory
- sameBrand
- campaign
type: string
description: 'Click Match Level: Campaign, Same SKU, Same Category or Same Brand'
default: campaign
dimensions:
type: array
items:
enum:
- date
- hour
- parentAccount
- accountId
- accountName
- accountTypeName
- advertiserType
- campaignId
- campaignName
- campaignTypeName
- campaignStartDate
- campaignEndDate
- lineItemId
- lineItemName
- lineItemStartDate
- lineItemEndDate
- lineItemStatus
- retailerId
- retailerName
- brandId
- brandName
- placementId
- placementName
- pageTypeName
- environment
- pageCategory
- advProductId
- advProductName
- advProductGtin
- advProductMpn
- buyType
- budgetModel
- activationPlatform
- soldBy
- saleChannel
- salesChannel
- mediaType
- attributionSettings
- activityType
- keyword
- skuRelation
- retailerCategoryId
- retailerCategoryName
- taxonomyBreadcrumb
- taxonomy1Id
- taxonomy1Name
- taxonomy2Id
- taxonomy2Name
- taxonomy3Id
- taxonomy3Name
- taxonomy4Id
- taxonomy4Name
- taxonomy5Id
- taxonomy5Name
- taxonomy6Id
- taxonomy6Name
- taxonomy7Id
- taxonomy7Name
- targetedKeywordType
type: string
description: List of dimensions to report on
endDate:
type: string
description: End date
format: date-time
format:
enum:
- json
- json-compact
- json-newline
- csv
type: string
description: Format of the output
default: json
id:
type: string
description: Supply account id to report on
ids:
type: array
items:
type: string
description: Supply account ids to report on
lineItemIds:
type: array
items:
type: string
description: Line item ids to filter
mediaType:
enum:
- unknown
- video
- display
- all
type: string
description: 'Filter on the type of media: unknown, display, video'
default: all
metrics:
type: array
items:
enum:
- numberOfCampaigns
- numberOfLineItems
- numberOfSkus
- skuPrice
- pageViews
- impressions
- productClicks
- placementClicks
- clicks
- sales
- units
- transactions
- assistedSales
- assistedUnits
- revenue
- openAuctionRevenue
- preferredDealsRevenue
- ctr
- cr
- cpc
- cpm
- roas
- workingMedia
- netRevenue
- videoViews
- videosStarted
- videosPlayedTo25
- videosPlayedTo50
- videosPlayedTo75
- videosPlayedTo100
- videoPlayingRate
- videoCompletionRate
- videoImpressions
- videoMuted
- videoUnmuted
- videoResumed
- videoPaused
- videoAvgInteractionRate
- videoViewability
- videoStartingRate
- videoCPC
- videoCPCV
- uniqueVisitors
- frequency
type: string
description: List of metrics to report on
reportType:
enum:
- advertiser
- environment
- pageType
- productCategory
- brand
type: string
description: >-
Type of report, if no dimensions and metrics are provided, falls
back to advertiser reportType
retailerIds:
type: array
items:
type: string
description: Retailer ids to filter
revenueType:
enum:
- auction
- preferred
type: string
description: Type of revenue
salesChannel:
enum:
- online
- offline
- all
type: string
description: 'Filter on specific sales channel: offline or online'
default: all
skuRelations:
type: array
items:
enum:
- sameSku
- sameParentSku
- sameCategory
- sameBrand
- sameSeller
type: string
description: >-
Filter on sku relations: Same SKU, Same Parent SKU, Same Category,
Same Brand or Same Seller
soldBy:
enum:
- directSold
- indirectSold
- privateMarket
- authorizedBuyer
type: string
description: >-
Filter on the seller: Indirect Sold, Direct Sold, Authorized Buyer
or Private Market
startDate:
type: string
description: Start date
format: date-time
targetedKeywordTypes:
type: array
items:
enum:
- unknown
- generic
- branded
- conquesting
type: string
description: >-
Filter on targeted keyword type: unknown, generic, branded,
conquesting
timezone:
type: string
description: 'Time zone : see criteo developer portal for supported time zones'
default: UTC
viewAttributionWindow:
enum:
- none
- 1D
- 7D
- 14D
- 30D
type: string
description: View attribution window
default: none
viewMatchLevel:
enum:
- sameSku
- sameCategory
- sameBrand
- campaign
type: string
description: 'View Match Level: Campaign, Same SKU, Same Category or Same Brand'
default: campaign
description: Async Revenue report body request
StatusResponse:
type: object
properties:
createdAt:
type: string
nullable: true
expiresAt:
type: string
nullable: true
fileSizeBytes:
type: integer
format: int64
nullable: true
id:
type: string
nullable: true
md5CheckSum:
type: string
nullable: true
message:
type: string
nullable: true
rowCount:
type: integer
format: int32
nullable: true
status:
enum:
- pending
- success
- failure
- expired
type: string
nullable: true
description: Status of an async report request
nullable: true
x-criteo-canonical:
infoType: entity
securitySchemes:
oauth:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api.criteo.com/oauth2/token
scopes: {}
authorizationCode:
authorizationUrl: https://api.criteo.com/oauth2
tokenUrl: https://api.criteo.com/oauth2/token
scopes: {}
````