/preview/reports/creatives
curl --request POST \
--url https://api.criteo.com/preview/reports/creatives \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "GenerateCreativesReport",
"attributes": {
"startDate": "2024-01-01T00:00:00.0000000+00:00",
"endDate": "2024-01-04T00:00:00.0000000+00:00",
"advertiserIds": [
"6666",
"7777"
],
"metrics": [
"Clicks",
"Ctr",
"Displays"
],
"dimensions": [
"SizeCategory",
"DisplaySize",
"AdFormat",
"Coupon",
"CouponId",
"Ad",
"AdId",
"Day",
"Hour"
],
"timezone": "Europe/Paris",
"adFormats": [
"Dynamic",
"Other formats"
],
"displaySizes": [
"LeaderBoard",
"LargeBanner"
],
"couponNames": [
"a coupon name"
],
"couponIds": [
"3333",
"5555"
],
"adNames": [
"Ad by Criteo team"
],
"adIds": [
"2222"
],
"campaignIds": [
"1111"
],
"adSetIds": [
"2222",
"3333"
],
"adSetStatus": [
"Active",
"NotRunning"
]
}
}
}
'import requests
url = "https://api.criteo.com/preview/reports/creatives"
payload = { "data": {
"type": "GenerateCreativesReport",
"attributes": {
"startDate": "2024-01-01T00:00:00.0000000+00:00",
"endDate": "2024-01-04T00:00:00.0000000+00:00",
"advertiserIds": ["6666", "7777"],
"metrics": ["Clicks", "Ctr", "Displays"],
"dimensions": ["SizeCategory", "DisplaySize", "AdFormat", "Coupon", "CouponId", "Ad", "AdId", "Day", "Hour"],
"timezone": "Europe/Paris",
"adFormats": ["Dynamic", "Other formats"],
"displaySizes": ["LeaderBoard", "LargeBanner"],
"couponNames": ["a coupon name"],
"couponIds": ["3333", "5555"],
"adNames": ["Ad by Criteo team"],
"adIds": ["2222"],
"campaignIds": ["1111"],
"adSetIds": ["2222", "3333"],
"adSetStatus": ["Active", "NotRunning"]
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'GenerateCreativesReport',
attributes: {
startDate: '2024-01-01T00:00:00.0000000+00:00',
endDate: '2024-01-04T00:00:00.0000000+00:00',
advertiserIds: ['6666', '7777'],
metrics: ['Clicks', 'Ctr', 'Displays'],
dimensions: [
'SizeCategory',
'DisplaySize',
'AdFormat',
'Coupon',
'CouponId',
'Ad',
'AdId',
'Day',
'Hour'
],
timezone: 'Europe/Paris',
adFormats: ['Dynamic', 'Other formats'],
displaySizes: ['LeaderBoard', 'LargeBanner'],
couponNames: ['a coupon name'],
couponIds: ['3333', '5555'],
adNames: ['Ad by Criteo team'],
adIds: ['2222'],
campaignIds: ['1111'],
adSetIds: ['2222', '3333'],
adSetStatus: ['Active', 'NotRunning']
}
}
})
};
fetch('https://api.criteo.com/preview/reports/creatives', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.criteo.com/preview/reports/creatives",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'GenerateCreativesReport',
'attributes' => [
'startDate' => '2024-01-01T00:00:00.0000000+00:00',
'endDate' => '2024-01-04T00:00:00.0000000+00:00',
'advertiserIds' => [
'6666',
'7777'
],
'metrics' => [
'Clicks',
'Ctr',
'Displays'
],
'dimensions' => [
'SizeCategory',
'DisplaySize',
'AdFormat',
'Coupon',
'CouponId',
'Ad',
'AdId',
'Day',
'Hour'
],
'timezone' => 'Europe/Paris',
'adFormats' => [
'Dynamic',
'Other formats'
],
'displaySizes' => [
'LeaderBoard',
'LargeBanner'
],
'couponNames' => [
'a coupon name'
],
'couponIds' => [
'3333',
'5555'
],
'adNames' => [
'Ad by Criteo team'
],
'adIds' => [
'2222'
],
'campaignIds' => [
'1111'
],
'adSetIds' => [
'2222',
'3333'
],
'adSetStatus' => [
'Active',
'NotRunning'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.criteo.com/preview/reports/creatives"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.criteo.com/preview/reports/creatives")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.criteo.com/preview/reports/creatives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"attributes": {
"rows": [
{}
]
},
"type": "<string>"
}
],
"errors": [
{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"source": {},
"stackTrace": "<string>",
"title": "<string>",
"traceId": "<string>",
"traceIdentifier": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"source": {},
"stackTrace": "<string>",
"title": "<string>",
"traceId": "<string>",
"traceIdentifier": "<string>"
}
]
}/preview/reports/creatives
With Creatives endpoint, you can analyse the daily performances of your creatives on the main metrics: clicks, ctr, displays.
This endpoint supports data retrieval for up to two years in the past.
POST
/
preview
/
reports
/
creatives
/preview/reports/creatives
curl --request POST \
--url https://api.criteo.com/preview/reports/creatives \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "GenerateCreativesReport",
"attributes": {
"startDate": "2024-01-01T00:00:00.0000000+00:00",
"endDate": "2024-01-04T00:00:00.0000000+00:00",
"advertiserIds": [
"6666",
"7777"
],
"metrics": [
"Clicks",
"Ctr",
"Displays"
],
"dimensions": [
"SizeCategory",
"DisplaySize",
"AdFormat",
"Coupon",
"CouponId",
"Ad",
"AdId",
"Day",
"Hour"
],
"timezone": "Europe/Paris",
"adFormats": [
"Dynamic",
"Other formats"
],
"displaySizes": [
"LeaderBoard",
"LargeBanner"
],
"couponNames": [
"a coupon name"
],
"couponIds": [
"3333",
"5555"
],
"adNames": [
"Ad by Criteo team"
],
"adIds": [
"2222"
],
"campaignIds": [
"1111"
],
"adSetIds": [
"2222",
"3333"
],
"adSetStatus": [
"Active",
"NotRunning"
]
}
}
}
'import requests
url = "https://api.criteo.com/preview/reports/creatives"
payload = { "data": {
"type": "GenerateCreativesReport",
"attributes": {
"startDate": "2024-01-01T00:00:00.0000000+00:00",
"endDate": "2024-01-04T00:00:00.0000000+00:00",
"advertiserIds": ["6666", "7777"],
"metrics": ["Clicks", "Ctr", "Displays"],
"dimensions": ["SizeCategory", "DisplaySize", "AdFormat", "Coupon", "CouponId", "Ad", "AdId", "Day", "Hour"],
"timezone": "Europe/Paris",
"adFormats": ["Dynamic", "Other formats"],
"displaySizes": ["LeaderBoard", "LargeBanner"],
"couponNames": ["a coupon name"],
"couponIds": ["3333", "5555"],
"adNames": ["Ad by Criteo team"],
"adIds": ["2222"],
"campaignIds": ["1111"],
"adSetIds": ["2222", "3333"],
"adSetStatus": ["Active", "NotRunning"]
}
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
type: 'GenerateCreativesReport',
attributes: {
startDate: '2024-01-01T00:00:00.0000000+00:00',
endDate: '2024-01-04T00:00:00.0000000+00:00',
advertiserIds: ['6666', '7777'],
metrics: ['Clicks', 'Ctr', 'Displays'],
dimensions: [
'SizeCategory',
'DisplaySize',
'AdFormat',
'Coupon',
'CouponId',
'Ad',
'AdId',
'Day',
'Hour'
],
timezone: 'Europe/Paris',
adFormats: ['Dynamic', 'Other formats'],
displaySizes: ['LeaderBoard', 'LargeBanner'],
couponNames: ['a coupon name'],
couponIds: ['3333', '5555'],
adNames: ['Ad by Criteo team'],
adIds: ['2222'],
campaignIds: ['1111'],
adSetIds: ['2222', '3333'],
adSetStatus: ['Active', 'NotRunning']
}
}
})
};
fetch('https://api.criteo.com/preview/reports/creatives', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.criteo.com/preview/reports/creatives",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'type' => 'GenerateCreativesReport',
'attributes' => [
'startDate' => '2024-01-01T00:00:00.0000000+00:00',
'endDate' => '2024-01-04T00:00:00.0000000+00:00',
'advertiserIds' => [
'6666',
'7777'
],
'metrics' => [
'Clicks',
'Ctr',
'Displays'
],
'dimensions' => [
'SizeCategory',
'DisplaySize',
'AdFormat',
'Coupon',
'CouponId',
'Ad',
'AdId',
'Day',
'Hour'
],
'timezone' => 'Europe/Paris',
'adFormats' => [
'Dynamic',
'Other formats'
],
'displaySizes' => [
'LeaderBoard',
'LargeBanner'
],
'couponNames' => [
'a coupon name'
],
'couponIds' => [
'3333',
'5555'
],
'adNames' => [
'Ad by Criteo team'
],
'adIds' => [
'2222'
],
'campaignIds' => [
'1111'
],
'adSetIds' => [
'2222',
'3333'
],
'adSetStatus' => [
'Active',
'NotRunning'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.criteo.com/preview/reports/creatives"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.criteo.com/preview/reports/creatives")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.criteo.com/preview/reports/creatives")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"type\": \"GenerateCreativesReport\",\n \"attributes\": {\n \"startDate\": \"2024-01-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2024-01-04T00:00:00.0000000+00:00\",\n \"advertiserIds\": [\n \"6666\",\n \"7777\"\n ],\n \"metrics\": [\n \"Clicks\",\n \"Ctr\",\n \"Displays\"\n ],\n \"dimensions\": [\n \"SizeCategory\",\n \"DisplaySize\",\n \"AdFormat\",\n \"Coupon\",\n \"CouponId\",\n \"Ad\",\n \"AdId\",\n \"Day\",\n \"Hour\"\n ],\n \"timezone\": \"Europe/Paris\",\n \"adFormats\": [\n \"Dynamic\",\n \"Other formats\"\n ],\n \"displaySizes\": [\n \"LeaderBoard\",\n \"LargeBanner\"\n ],\n \"couponNames\": [\n \"a coupon name\"\n ],\n \"couponIds\": [\n \"3333\",\n \"5555\"\n ],\n \"adNames\": [\n \"Ad by Criteo team\"\n ],\n \"adIds\": [\n \"2222\"\n ],\n \"campaignIds\": [\n \"1111\"\n ],\n \"adSetIds\": [\n \"2222\",\n \"3333\"\n ],\n \"adSetStatus\": [\n \"Active\",\n \"NotRunning\"\n ]\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"attributes": {
"rows": [
{}
]
},
"type": "<string>"
}
],
"errors": [
{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"source": {},
"stackTrace": "<string>",
"title": "<string>",
"traceId": "<string>",
"traceIdentifier": "<string>"
}
],
"warnings": [
{
"code": "<string>",
"detail": "<string>",
"instance": "<string>",
"source": {},
"stackTrace": "<string>",
"title": "<string>",
"traceId": "<string>",
"traceIdentifier": "<string>"
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/jsonapplication/xmltext/xmlapplication/*+xml
A top-level object that encapsulates a Criteo API request for a single value object.
A value resource exposed by the API.
Show child attributes
Show child attributes
Response
Success
A top-level object that encapsulates a Criteo API response for several value objects.
Was this page helpful?
⌘I