> ## 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.

# Creatives Report

## Introduction

The creatives report provides performance metrics from your creatives, including the number of displays, clicks, and click-through rate. These reports include the ability to be broken down by formats, display sizes, coupons, ads, ad types, and date or time.

## Making a call

Creatives report is available at the following endpoint:

Below is an example of the body for the POST call:

```json Example POST body theme={null}
{
	"data": {
    "type": "CreativesReport",
    "attributes": {
      "startDate": "2022-01-01",
      "endDate": "2022-01-02",
      "dimensions": ["SizeCategory", "DisplaySize", "Day"],
      "metrics": ["Clicks", "Displays", "Ctr"],
      "advertiserIds": ["1111", "2222"],
      "format": ["Dynamic"],
      "displaySizes": ["MediumBanner"],
      "couponNames": [],
      "campaignIds": ["1234"],
      "adSetIds": ["789", "456"],
      "adSetStatus": ["Active", "NotRunning"]
      }
   }
}
```

There are 5 required attributes when making a call:  *startDate*, *endDate*, *dimensions*, *metrics* and *advertiserIds*.

The POST call will generate a report in the format of a JSON document. This is a response example:

```json expandable theme={null}
{
  "data": [
		{
      "type": "CreativesReport",
      "attributes": {
        "rows": [
          {
            "sizeCategory": "Placements",
            "displaySize": "HalfPage",
            "day": "2021-10-01",
            "displays": "65432",
            "clicks": "123",
            "ctr": "0.0222"
          },
          {
            "sizeCategory": "Placements",
            "displaySize": "HalfPage",
            "day": "2021-10-02",
            "displays": "45678",
            "clicks": "654",
            "ctr": "0.044"
          },
          ...
          {
            "sizeCategory": "Unknown sizes",
            "displaySize": "Others",
            "day": "2021-10-05",
            "displays": "12345",
            "clicks": "321",
            "ctr": "0.0111"
          }
        ]
      }
    }
  ]
}
```

## Metrics

<table>
  <thead>
    <tr>
      <th>
        <p>
          Value
        </p>
      </th>

      <th>
        <p>
          Description
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          displays
        </p>
      </td>

      <td>
        <p>
          Number of displays
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          clicks
        </p>
      </td>

      <td>
        <p>
          Number of clicks
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ctr
        </p>
      </td>

      <td>
        <p>
          Click Through Rate
        </p>
      </td>
    </tr>
  </tbody>
</table>

## Dimensions

<table>
  <thead>
    <tr>
      <th>
        <p>
          Value
        </p>
      </th>

      <th>
        <p>
          Description
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          adType
        </p>
      </td>

      <td>
        <p>
          Classification of ads based on required brand assets and potential reach
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          coupon
        </p>
      </td>

      <td>
        <p>
          Static images displayed within an ad creative. Usually used to deliver commercial offers or branding messages
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          couponId
        </p>
      </td>

      <td>
        <p>
          Id of the coupon
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          sizeCategory
        </p>
      </td>

      <td>
        <p>
          Grouping of display sizes by category
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          displaySize
        </p>
      </td>

      <td>
        <p>
          The displayed size of the ad expressed in pixels
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ad
        </p>
      </td>

      <td>
        <p>
          Name of the ad
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          adId
        </p>
      </td>

      <td>
        <p>
          Id of the ad
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          day
        </p>
      </td>

      <td>
        <p>
          Represents date in a day format
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          hour
        </p>
      </td>

      <td>
        <p>
          Represents date in an hour format
        </p>
      </td>
    </tr>
  </tbody>
</table>

## Attributes

<table>
  <thead>
    <tr>
      <th>
        <p>
          Field
        </p>
      </th>

      <th>
        <p>
          Type
        </p>
      </th>

      <th>
        <p>
          Required
        </p>
      </th>

      <th>
        <p>
          Default Value
        </p>
      </th>

      <th>
        <p>
          Description
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          startDate
        </p>
      </td>

      <td>
        <p>
          DateTime
        </p>
      </td>

      <td>
        <p>
          Yes
        </p>
      </td>

      <td />

      <td>
        <p>
          Start of the report in YY-MM-DD format
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          endDate
        </p>
      </td>

      <td>
        <p>
          DateTime
        </p>
      </td>

      <td>
        <p>
          Yes
        </p>
      </td>

      <td />

      <td>
        <p>
          End of the report in YY-MM-DD format
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          dimensions
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          Yes
        </p>
      </td>

      <td />

      <td>
        <p>
          List of dimensions to retrieve
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          metrics
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          Yes
        </p>
      </td>

      <td />

      <td>
        <p>
          List of metrics to retrieve
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          advertiserIds
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          Yes
        </p>
      </td>

      <td />

      <td>
        <p>
          Ids of the advertisers
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          timezone
        </p>
      </td>

      <td>
        <p>
          string
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td>
        <p>
          UTC
        </p>
      </td>

      <td>
        <p>
          Timezone used for dates
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          format
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified ad types
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          displaySizes
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified display sizes
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          couponNames
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified coupon names
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          campaignIds
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified campaign ids
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          adSetIds
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified adSet ids
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          adSetStatus
        </p>
      </td>

      <td>
        <p>
          string\[]
        </p>
      </td>

      <td>
        <p>
          No
        </p>
      </td>

      <td />

      <td>
        <p>
          Report only on the specified adSet status
        </p>
      </td>
    </tr>
  </tbody>
</table>