> ## 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/placements/report

> Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.
<br/><br/>
This endpoint supports data retrieval for up to three months in the past.



## OpenAPI

````yaml https://api.criteo.com/preview/marketingsolutions/open-api-specifications.json post /preview/placements/report
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/placements/report:
    post:
      tags:
        - Analytics
      summary: /preview/placements/report
      description: "Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.\r\n<br/><br/>\r\nThis endpoint supports data retrieval for up to three months in the past."
      operationId: GetPlacementsReport
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example:
              data:
                - type: report
                  attributes:
                    advertiserIds: 123,456,789
                    campaignIds: 111,222,333,444
                    adsetIds: 135,246,357,468
                    environment: Web
                    placement: MyPlacement
                    dimensions:
                      - AdsetId
                      - AdvertiserId
                      - Placement
                    metrics:
                      - Clicks
                      - Displays
                      - Cost
                    currency: EUR
                    disclosed: false
                    format: csv
                    timezone: Europe/Paris
                    startDate: '2024-01-01T00:00:00.0000000+00:00'
                    endDate: '2024-01-04T00:00:00.0000000+00:00'
          application/xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
          text/xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
          application/*+xml:
            schema:
              $ref: '#/components/schemas/PlacementsReportQueryMessageListRequest'
            example: "<ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Resources\">\r\n  <Data>\r\n    <ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n      <Attributes xmlns:d4p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Messages\">\r\n        <d4p1:EndDate>2024-01-04T00:00:00</d4p1:EndDate>\r\n        <d4p1:StartDate>2024-01-01T00:00:00</d4p1:StartDate>\r\n        <d4p1:Format>csv</d4p1:Format>\r\n        <d4p1:Timezone>Europe/Paris</d4p1:Timezone>\r\n        <d4p1:AdsetIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>135</d6p1:int>\r\n            <d6p1:int>246</d6p1:int>\r\n            <d6p1:int>357</d6p1:int>\r\n            <d6p1:int>468</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdsetIds>\r\n        <d4p1:AdvertiserIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>123</d6p1:int>\r\n            <d6p1:int>456</d6p1:int>\r\n            <d6p1:int>789</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:AdvertiserIds>\r\n        <d4p1:CampaignIds>\r\n          <d4p1:Values xmlns:d6p1=\"http://schemas.microsoft.com/2003/10/Serialization/Arrays\">\r\n            <d6p1:int>111</d6p1:int>\r\n            <d6p1:int>222</d6p1:int>\r\n            <d6p1:int>333</d6p1:int>\r\n            <d6p1:int>444</d6p1:int>\r\n          </d4p1:Values>\r\n        </d4p1:CampaignIds>\r\n        <d4p1:Currency>EUR</d4p1:Currency>\r\n        <d4p1:Dimensions xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportDimensions>AdsetId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>AdvertiserId</d5p1:PlacementsReportDimensions>\r\n          <d5p1:PlacementsReportDimensions>Placement</d5p1:PlacementsReportDimensions>\r\n        </d4p1:Dimensions>\r\n        <d4p1:Disclosed>false</d4p1:Disclosed>\r\n        <d4p1:Environment>Web</d4p1:Environment>\r\n        <d4p1:IsInternal>false</d4p1:IsInternal>\r\n        <d4p1:Metrics xmlns:d5p1=\"http://schemas.datacontract.org/2004/07/Criteo.Api.Exam.Statistics.Controllers.V1.Models\">\r\n          <d5p1:PlacementsReportMetrics>Clicks</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Displays</d5p1:PlacementsReportMetrics>\r\n          <d5p1:PlacementsReportMetrics>Cost</d5p1:PlacementsReportMetrics>\r\n        </d4p1:Metrics>\r\n        <d4p1:Placement>MyPlacement</d4p1:Placement>\r\n      </Attributes>\r\n      <Type>report</Type>\r\n    </ValueResourceOfPlacementsReportQueryMessagetukRIHCU>\r\n  </Data>\r\n</ValueResourceCollectionInputOfPlacementsReportQueryMessagetukRIHCU>"
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
                format: binary
            text/csv:
              schema:
                type: string
                format: binary
            text/xml:
              schema:
                type: string
                format: binary
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                type: string
                format: binary
      security:
        - oauth:
            - MarketingSolutions_Analytics_Read
components:
  schemas:
    PlacementsReportQueryMessageListRequest:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PlacementsReportQueryMessageResource'
          nullable: true
      additionalProperties: false
      description: >-
        A top-level object that encapsulates a Criteo API request for several
        value objects.
    PlacementsReportQueryMessageResource:
      type: object
      properties:
        attributes:
          $ref: '#/components/schemas/PlacementsReportQueryMessage'
        type:
          type: string
          description: Type of the resource.
          nullable: true
      additionalProperties: false
      description: A value resource exposed by the API.
    PlacementsReportQueryMessage:
      required:
        - advertiserIds
        - currency
        - dimensions
        - endDate
        - metrics
        - startDate
      type: object
      properties:
        adsetIds:
          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:
          type: string
          description: >-
            List of advertiser IDs to report on, provided as a single
            comma-separated string (e.g., "123,456,789"). The advertisers must
            already exist. If empty, all advertisers will be used.
        campaignIds:
          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).
        dimensions:
          minItems: 1
          type: array
          items:
            enum:
              - AdsetId
              - AdvertiserId
              - Placement
              - Environment
              - AdsetName
              - AdvertiserName
              - CampaignId
              - CampaignName
              - AdChannel
              - SocialPlatform
              - CategoryId
              - CategoryName
            type: string
          description: >-
            List of dimensions for the report. At least one dimension should be
            provided.
        disclosed:
          type: boolean
          description: Optionally returns disclosed or undisclosed placements.
          default: true
        endDate:
          type: string
          description: >-
            End date of the report. Date component of ISO 8601 format, any time
            or timezone component is ignored.
          format: date-time
        environment:
          enum:
            - Web
            - Android
            - Ios
          type: string
          description: >-
            Optional type of environment to filter on. If empty, all
            environments will be included.
          nullable: true
        format:
          enum:
            - csv
            - excel
            - xml
            - json
          type: string
          description: Optional file format of the generated report.
          default: json
        metrics:
          minItems: 1
          type: array
          items:
            enum:
              - Clicks
              - Displays
              - Cost
              - SalesPc30d
              - RevenuePc30d
              - CosPc30d
              - RoasPc30d
              - CpoPc30d
              - CvrPc30d
              - SalesPv1d
              - RevenuePv1d
              - CosPv1d
              - RoasPv1d
              - CpoPv1d
              - CvrPv1d
            type: string
          description: >-
            List of metrics for the report. At least one dimension should be
            provided.
        placement:
          type: string
          description: >-
            Optional filter on a specific placement domain name. If empty, all
            placements will be included.
          nullable: true
        startDate:
          type: string
          description: >-
            Start date of the report. Date component of ISO 8601 format, any
            time or timezone component is ignored. Must be ≤ endDate.
          format: date-time
        timezone:
          type: string
          description: >-
            Optional timezone used for the report. Timezone Database format
            (Tz).
          default: UTC
          nullable: true
      additionalProperties: false
      description: This is the message defining the query for Placements report
  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: {}

````