> ## 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/reports/realtime

> With Realtime endpoint, you can analyse the realtime values of the main metrics: displays, clicks, cost.



## OpenAPI

````yaml https://api.criteo.com/preview/marketingsolutions/open-api-specifications.json post /preview/reports/realtime
openapi: 3.0.1
info:
  title: Criteo API
  description: Criteo API - MarketingSolutions
  version: Preview
servers:
  - url: https://api.criteo.com
security:
  - oauth: []
tags:
  - name: Advertiser
  - name: Analytics
  - name: Audience
  - name: Campaign
  - name: Catalog
  - name: Creative
  - name: Gateway
  - name: OnSiteRecommendation
  - name: Reco
paths:
  /preview/reports/realtime:
    post:
      tags:
        - Analytics
      summary: /preview/reports/realtime
      description: >-
        With Realtime endpoint, you can analyse the realtime values of the main
        metrics: displays, clicks, cost.
      operationId: GetRealtimeStatisticsReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributesRequest
            example:
              data:
                type: GenerateRealtimeStatisticsReport
                attributes:
                  advertiserIds:
                    - '123'
                    - '456'
                  campaignIds:
                    - '111'
                  adsetIds:
                    - '135'
                  dimensions:
                    - AdvertiserId
                    - Advertiser
                    - CampaignId
                    - Campaign
                    - AdsetId
                    - Adset
                    - Day
                    - Hour
                  metrics:
                    - Displays
                    - Clicks
                    - Cost
                  lookbackWindow: 12
                  currency: EUR
                  timezone: Europe/Paris
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributesRequest
            example: "<ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <Attributes xmlns:d3p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n      <d3p1:AdsetIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>135</d4p1:string>\r\n      </d3p1:AdsetIds>\r\n      <d3p1:AdvertiserIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>123</d4p1:string>\r\n        <d4p1:string>456</d4p1:string>\r\n      </d3p1:AdvertiserIds>\r\n      <d3p1:CampaignIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>111</d4p1:string>\r\n      </d3p1:CampaignIds>\r\n      <d3p1:Currency>EUR</d3p1:Currency>\r\n      <d3p1:Dimensions xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsDimensions>AdvertiserId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Advertiser</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>CampaignId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Campaign</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>AdsetId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Adset</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Day</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Hour</d4p1:RealtimeStatisticsDimensions>\r\n      </d3p1:Dimensions>\r\n      <d3p1:IsInternal>false</d3p1:IsInternal>\r\n      <d3p1:LookbackWindow>12</d3p1:LookbackWindow>\r\n      <d3p1:Metrics xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsMetrics>Displays</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Clicks</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Cost</d4p1:RealtimeStatisticsMetrics>\r\n      </d3p1:Metrics>\r\n      <d3p1:Timezone>Europe/Paris</d3p1:Timezone>\r\n    </Attributes>\r\n    <Type>GenerateRealtimeStatisticsReport</Type>\r\n  </Data>\r\n</ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU>"
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributesRequest
            example: "<ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <Attributes xmlns:d3p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n      <d3p1:AdsetIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>135</d4p1:string>\r\n      </d3p1:AdsetIds>\r\n      <d3p1:AdvertiserIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>123</d4p1:string>\r\n        <d4p1:string>456</d4p1:string>\r\n      </d3p1:AdvertiserIds>\r\n      <d3p1:CampaignIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>111</d4p1:string>\r\n      </d3p1:CampaignIds>\r\n      <d3p1:Currency>EUR</d3p1:Currency>\r\n      <d3p1:Dimensions xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsDimensions>AdvertiserId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Advertiser</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>CampaignId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Campaign</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>AdsetId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Adset</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Day</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Hour</d4p1:RealtimeStatisticsDimensions>\r\n      </d3p1:Dimensions>\r\n      <d3p1:IsInternal>false</d3p1:IsInternal>\r\n      <d3p1:LookbackWindow>12</d3p1:LookbackWindow>\r\n      <d3p1:Metrics xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsMetrics>Displays</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Clicks</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Cost</d4p1:RealtimeStatisticsMetrics>\r\n      </d3p1:Metrics>\r\n      <d3p1:Timezone>Europe/Paris</d3p1:Timezone>\r\n    </Attributes>\r\n    <Type>GenerateRealtimeStatisticsReport</Type>\r\n  </Data>\r\n</ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU>"
          application/*+xml:
            schema:
              $ref: >-
                #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributesRequest
            example: "<ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <Attributes xmlns:d3p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n      <d3p1:AdsetIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>135</d4p1:string>\r\n      </d3p1:AdsetIds>\r\n      <d3p1:AdvertiserIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>123</d4p1:string>\r\n        <d4p1:string>456</d4p1:string>\r\n      </d3p1:AdvertiserIds>\r\n      <d3p1:CampaignIds xmlns:d4p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n        <d4p1:string>111</d4p1:string>\r\n      </d3p1:CampaignIds>\r\n      <d3p1:Currency>EUR</d3p1:Currency>\r\n      <d3p1:Dimensions xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsDimensions>AdvertiserId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Advertiser</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>CampaignId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Campaign</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>AdsetId</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Adset</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Day</d4p1:RealtimeStatisticsDimensions>\r\n        <d4p1:RealtimeStatisticsDimensions>Hour</d4p1:RealtimeStatisticsDimensions>\r\n      </d3p1:Dimensions>\r\n      <d3p1:IsInternal>false</d3p1:IsInternal>\r\n      <d3p1:LookbackWindow>12</d3p1:LookbackWindow>\r\n      <d3p1:Metrics xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n        <d4p1:RealtimeStatisticsMetrics>Displays</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Clicks</d4p1:RealtimeStatisticsMetrics>\r\n        <d4p1:RealtimeStatisticsMetrics>Cost</d4p1:RealtimeStatisticsMetrics>\r\n      </d3p1:Metrics>\r\n      <d3p1:Timezone>Europe/Paris</d3p1:Timezone>\r\n    </Attributes>\r\n    <Type>GenerateRealtimeStatisticsReport</Type>\r\n  </Data>\r\n</ValueResourceInputOfGenerateRealtimeStatisticsReportRequestAttributestukRIHCU>"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonReportRowsListResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/JsonReportRowsListResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/JsonReportRowsListResponse'
      security:
        - oauth:
            - MarketingSolutions_Analytics_Read
components:
  schemas:
    GenerateRealtimeStatisticsReportRequestAttributesRequest:
      type: object
      properties:
        data:
          $ref: >-
            #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributesResource
      additionalProperties: false
      description: >-
        A top-level object that encapsulates a Criteo API request for a single
        value object.
    JsonReportRowsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/JsonReportRowsResource'
          nullable: true
        errors:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          description: Errors that occured during this call.
          nullable: true
          readOnly: true
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/CommonProblem'
          description: Warnings that occured during this call.
          nullable: true
          readOnly: true
      additionalProperties: false
      description: >-
        A top-level object that encapsulates a Criteo API response for several
        value objects.
    GenerateRealtimeStatisticsReportRequestAttributesResource:
      type: object
      properties:
        attributes:
          $ref: >-
            #/components/schemas/GenerateRealtimeStatisticsReportRequestAttributes
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    JsonReportRowsResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/JsonReportRows'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    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.
    GenerateRealtimeStatisticsReportRequestAttributes:
      required:
        - advertiserIds
      type: object
      properties:
        adsetIds:
          type: array
          items:
            type: string
          description: >-
            Optional list of ad set IDs to filter on. The ad sets must already
            exist. If empty, all ad sets will be included.
          nullable: true
        advertiserIds:
          maxItems: 10
          minItems: 1
          type: array
          items:
            type: string
          description: >-
            List of advertiser IDs to report on. The advertisers must already
            exist. Between 1 and 10 advertiser IDs can be provided.
        campaignIds:
          type: array
          items:
            type: string
          description: >-
            Optional list of campaign IDs to filter on. The campaigns must
            already exist. If empty, all campaigns will be included.
          nullable: true
        currency:
          type: string
          description: >-
            The currency used for the report. ISO 4217 code (three-letter
            capitals).
          default: EUR
          nullable: true
        dimensions:
          type: array
          items:
            enum:
              - Advertiser
              - AdvertiserId
              - Campaign
              - CampaignId
              - Adset
              - AdsetId
              - Year
              - Month
              - Week
              - Day
              - Hour
            type: string
          description: >-
            List of dimensions for the report. If not included, the default list
            of dimensions will be used.
          default:
            - AdvertiserId
            - Advertiser
            - CampaignId
            - Campaign
            - AdsetId
            - Adset
            - Day
            - Hour
          nullable: true
        lookbackWindow:
          maximum: 24
          minimum: 1
          type: integer
          description: Optional number of hours to consider in the past.
          format: int32
          default: 12
        metrics:
          type: array
          items:
            enum:
              - Clicks
              - Cost
              - Displays
            type: string
          description: >-
            List of metrics for the report. If included, at least one metric
            should be provided.
          default:
            - Displays
            - Clicks
            - Cost
          nullable: true
        timezone:
          type: string
          description: Optional timezone used for the report.
          default: UTC
          nullable: true
      additionalProperties: false
      description: This is the message defining the query for Realtime report
    JsonReportRows:
      type: object
      properties:
        rows:
          type: array
          items:
            type: object
            additionalProperties:
              type: string
          nullable: true
      additionalProperties: false
      description: This is the message defining the json report rows
      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: {}

````