> ## 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.
# /preview/retail-media/reports/sync/real-time-performance
> Returns a synchronous Real Time Performance Report. Returns empty rows; metadata includes dataCompleteThrough (latest time from streaming table in the request timezone).
This endpoint is subject to specific rate limits.
## OpenAPI
````yaml https://api.criteo.com/preview/retailmedia/open-api-specifications.json post /preview/retail-media/reports/sync/real-time-performance
openapi: 3.0.1
info:
title: Criteo API
description: Criteo API - RetailMedia
version: Preview
servers:
- url: https://api.criteo.com
security:
- oauth: []
tags:
- name: Accounts
- name: Analytics
- name: Audience
- name: Balance
- name: Campaign
- name: Catalog
- name: Gateway
- name: OnSiteRecommendation
- name: ThirdPartyAccounts
paths:
/preview/retail-media/reports/sync/real-time-performance:
post:
tags:
- Analytics
summary: /preview/retail-media/reports/sync/real-time-performance
description: "Returns a synchronous Real Time Performance Report. Returns empty rows; metadata includes dataCompleteThrough (latest time from streaming table in the request timezone).\r\n
\r\nThis endpoint is subject to specific rate limits."
operationId: GenerateSyncRealTimePerformanceReport
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SyncRealTimePerformanceReportRequest'
required: true
x-bodyName: request
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ReportResponse'
security:
- oauth:
- RetailMedia_Analytics_Read
components:
schemas:
SyncRealTimePerformanceReportRequest:
type: object
properties:
data:
$ref: '#/components/schemas/SyncRealTimePerformanceReportResource'
description: >-
A top-level object that encapsulates a Criteo API request for a single
value
ReportResponse:
type: object
properties:
data:
$ref: '#/components/schemas/ReportDataResponseResource'
errors:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
readOnly: true
meta:
$ref: '#/components/schemas/ExportReportMetaData'
warnings:
type: array
items:
$ref: '#/components/schemas/CommonProblem'
nullable: true
readOnly: true
description: Report response format
SyncRealTimePerformanceReportResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/SyncRealTimePerformanceReport'
type:
type: string
description: >-
A top-level object that encapsulates a Criteo API response for a single
value
ReportDataResponseResource:
type: object
properties:
attributes:
type: array
items:
type: array
items:
type: object
description: Data response format
nullable: true
type:
type: string
nullable: true
description: >-
A top-level object that encapsulates a Criteo API response for a single
value
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.
ExportReportMetaData:
type: object
properties:
columns:
type: array
items:
$ref: '#/components/schemas/ExportReportColumn'
nullable: true
dataCompleteThrough:
$ref: '#/components/schemas/DataCompleteThrough'
rows:
type: integer
format: int32
nullable: true
description: >-
Metadata for a report response: data freshness, column descriptions, and
row count.
nullable: true
SyncRealTimePerformanceReport:
required:
- startDate
type: object
properties:
accountIds:
type: array
items:
type: string
description: >-
Account ids to filter (plural; base has AccountId for single
account).
campaignIds:
type: array
items:
type: string
description: Campaign ids to filter.
dimensions:
type: array
items:
enum:
- date
- hour
- accountId
- accountName
- campaignId
- campaignName
- lineItemId
- lineItemName
- retailerId
- retailerName
type: string
description: "Dimensions supported by the real-time performance report (streaming + hourly stats).\r\nOnly these values are accepted; invalid values cause deserialization to fail."
description: >-
List of dimensions to report on (real-time: at least one required).
Only values from
Criteo.RetailMedia.Exam.Reporting.Resources.Models.Inputs.RealTimePerformance.SyncRealTimeDimension
are valid.
endDate:
type: string
description: "Optional end date/time (inclusive in the request timezone). If empty or not provided, no end date filter is applied.\r\nWhen provided, used as the inclusive upper bound for the report range.\r\nHides base Report.EndDate so this report can treat end date as optional (no [Required])."
format: date-time
lineItemIds:
type: array
items:
type: string
description: Line item ids to filter.
metrics:
type: array
items:
enum:
- impressions
- clicks
- spend
type: string
description: "Metrics supported by the real-time performance report (streaming + hourly stats).\r\nOnly these values are accepted; invalid values cause deserialization to fail."
description: >-
List of metrics to report on (real-time: at least one required).
Only values from
Criteo.RetailMedia.Exam.Reporting.Resources.Models.Inputs.RealTimePerformance.SyncRealTimeMetric
are valid.
retailerIds:
type: array
items:
type: string
description: >-
Retailer ids to filter. This is not used for security, so no need to
check for > 0 elements
startDate:
type: string
description: 'Start date (real-time: must be within the last 7 days).'
format: date-time
timezone:
type: string
description: 'Time zone : see criteo developer portal for supported time zones'
default: UTC
description: "Real Time Performance report body request (one sheeter: startDate, endDate (optional), RetailerIds, accountIds, campaignIds, lineItemIds, dimensions, metrics, timezones).\r\nExtends SyncReport only (no default filters); adds entry filter arrays.\r\nDimensions and metrics are restricted to Criteo.RetailMedia.Exam.Reporting.Resources.Models.Inputs.RealTimePerformance.SyncRealTimeDimension and Criteo.RetailMedia.Exam.Reporting.Resources.Models.Inputs.RealTimePerformance.SyncRealTimeMetric; invalid values cause deserialization to fail."
ExportReportColumn:
required:
- name
- role
- type
type: object
properties:
currency:
type: string
description: Currency of the column
nullable: true
deprecated:
type: boolean
description: Flag for deprecated column
nullable: true
description:
type: string
description: Description of the exported column
nullable: true
duration:
type: string
description: Duration of the column
nullable: true
name:
type: string
description: Name of the exported column
role:
enum:
- Dimension
- Property
- Interval
- Metric
type: string
description: Role of the column
timezone:
type: string
description: Timezone of the column
nullable: true
title:
type: string
description: Title of the exported column
nullable: true
type:
enum:
- Boolean
- Number
- Money
- String
- Date
- DateTime
- Interval
- Duration
type: string
description: Type of the column
description: Description of a column from an async report request
DataCompleteThrough:
type: object
properties:
dateTime:
type: string
description: >-
The instant through which data is complete, in the format
"yyyy-MM-dd HH:mm:ss" in
Criteo.RetailMedia.Exam.Reporting.Resources.Models.Outputs.DataCompleteThrough.Timezone.
nullable: true
timezone:
type: string
description: >-
IANA timezone for
Criteo.RetailMedia.Exam.Reporting.Resources.Models.Outputs.DataCompleteThrough.DateTime
(e.g. "UTC", "America/New_York"). Matches the query timezone.
nullable: true
description: >-
Data freshness: the instant through which report data is complete,
expressed in the report's request timezone.
nullable: true
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: {}
````