/preview/retail-media/insights/share-of-voice
curl --request POST \
--url https://api.criteo.com/preview/retail-media/insights/share-of-voice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "ShareOfVoiceInsight",
"attributes": {
"startDate": "2026-06-01T00:00:00.0000000+00:00",
"endDate": "2026-06-07T00:00:00.0000000+00:00",
"aggregationLevel": "category",
"dimensions": [
"date",
"accountId",
"accountName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"campaignId",
"campaignName",
"buyType",
"skuId",
"skuName",
"lineItemId",
"lineItemName",
"pageTypeId",
"pageTypeName",
"productGtin",
"productMpn",
"productCategory",
"servedCategory",
"keyword",
"keywordType",
"campaignType",
"creativeType",
"adFormat",
"creativeName",
"environment",
"budgetModel",
"activationPlatform"
],
"metrics": [
"impressions",
"clicks",
"grossClicks",
"spend",
"cpc",
"ctr",
"cpm",
"roas",
"attributedSales",
"attributedUnits",
"assistedUnits",
"assistedSales",
"exposedUsers",
"impressionShare",
"clickShare",
"invalidClicks"
],
"filters": {
"campaignType": "onsiteSponsoredProducts",
"accountIds": [
"12345"
],
"retailerIds": [
"123"
],
"brandIds": [
"456"
],
"servedCategories": [
"Sports & Outdoors/Footwear/Running Shoes"
],
"keywords": [
"running shoes"
],
"keywordTypes": [
"generic"
],
"budgetModels": [
"criteoBudget"
],
"activationPlatforms": [
"commerceMax"
]
},
"accountId": "12345",
"format": "json-compact"
}
}
}
'import requests
url = "https://api.criteo.com/preview/retail-media/insights/share-of-voice"
payload = { "data": {
"type": "ShareOfVoiceInsight",
"attributes": {
"startDate": "2026-06-01T00:00:00.0000000+00:00",
"endDate": "2026-06-07T00:00:00.0000000+00:00",
"aggregationLevel": "category",
"dimensions": ["date", "accountId", "accountName", "retailerId", "retailerName", "brandId", "brandName", "campaignId", "campaignName", "buyType", "skuId", "skuName", "lineItemId", "lineItemName", "pageTypeId", "pageTypeName", "productGtin", "productMpn", "productCategory", "servedCategory", "keyword", "keywordType", "campaignType", "creativeType", "adFormat", "creativeName", "environment", "budgetModel", "activationPlatform"],
"metrics": ["impressions", "clicks", "grossClicks", "spend", "cpc", "ctr", "cpm", "roas", "attributedSales", "attributedUnits", "assistedUnits", "assistedSales", "exposedUsers", "impressionShare", "clickShare", "invalidClicks"],
"filters": {
"campaignType": "onsiteSponsoredProducts",
"accountIds": ["12345"],
"retailerIds": ["123"],
"brandIds": ["456"],
"servedCategories": ["Sports & Outdoors/Footwear/Running Shoes"],
"keywords": ["running shoes"],
"keywordTypes": ["generic"],
"budgetModels": ["criteoBudget"],
"activationPlatforms": ["commerceMax"]
},
"accountId": "12345",
"format": "json-compact"
}
} }
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: 'ShareOfVoiceInsight',
attributes: {
startDate: '2026-06-01T00:00:00.0000000+00:00',
endDate: '2026-06-07T00:00:00.0000000+00:00',
aggregationLevel: 'category',
dimensions: [
'date',
'accountId',
'accountName',
'retailerId',
'retailerName',
'brandId',
'brandName',
'campaignId',
'campaignName',
'buyType',
'skuId',
'skuName',
'lineItemId',
'lineItemName',
'pageTypeId',
'pageTypeName',
'productGtin',
'productMpn',
'productCategory',
'servedCategory',
'keyword',
'keywordType',
'campaignType',
'creativeType',
'adFormat',
'creativeName',
'environment',
'budgetModel',
'activationPlatform'
],
metrics: [
'impressions',
'clicks',
'grossClicks',
'spend',
'cpc',
'ctr',
'cpm',
'roas',
'attributedSales',
'attributedUnits',
'assistedUnits',
'assistedSales',
'exposedUsers',
'impressionShare',
'clickShare',
'invalidClicks'
],
filters: {
campaignType: 'onsiteSponsoredProducts',
accountIds: ['12345'],
retailerIds: ['123'],
brandIds: ['456'],
servedCategories: ['Sports & Outdoors/Footwear/Running Shoes'],
keywords: ['running shoes'],
keywordTypes: ['generic'],
budgetModels: ['criteoBudget'],
activationPlatforms: ['commerceMax']
},
accountId: '12345',
format: 'json-compact'
}
}
})
};
fetch('https://api.criteo.com/preview/retail-media/insights/share-of-voice', 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/retail-media/insights/share-of-voice",
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' => 'ShareOfVoiceInsight',
'attributes' => [
'startDate' => '2026-06-01T00:00:00.0000000+00:00',
'endDate' => '2026-06-07T00:00:00.0000000+00:00',
'aggregationLevel' => 'category',
'dimensions' => [
'date',
'accountId',
'accountName',
'retailerId',
'retailerName',
'brandId',
'brandName',
'campaignId',
'campaignName',
'buyType',
'skuId',
'skuName',
'lineItemId',
'lineItemName',
'pageTypeId',
'pageTypeName',
'productGtin',
'productMpn',
'productCategory',
'servedCategory',
'keyword',
'keywordType',
'campaignType',
'creativeType',
'adFormat',
'creativeName',
'environment',
'budgetModel',
'activationPlatform'
],
'metrics' => [
'impressions',
'clicks',
'grossClicks',
'spend',
'cpc',
'ctr',
'cpm',
'roas',
'attributedSales',
'attributedUnits',
'assistedUnits',
'assistedSales',
'exposedUsers',
'impressionShare',
'clickShare',
'invalidClicks'
],
'filters' => [
'campaignType' => 'onsiteSponsoredProducts',
'accountIds' => [
'12345'
],
'retailerIds' => [
'123'
],
'brandIds' => [
'456'
],
'servedCategories' => [
'Sports & Outdoors/Footwear/Running Shoes'
],
'keywords' => [
'running shoes'
],
'keywordTypes' => [
'generic'
],
'budgetModels' => [
'criteoBudget'
],
'activationPlatforms' => [
'commerceMax'
]
],
'accountId' => '12345',
'format' => 'json-compact'
]
]
]),
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/retail-media/insights/share-of-voice"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\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/retail-media/insights/share-of-voice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.criteo.com/preview/retail-media/insights/share-of-voice")
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\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"type": "InsightStatus",
"attributes": {
"status": "Success",
"message": "rows_count=1234",
"createdAt": "2026-07-01T12:00:00.0000000+00:00",
"expiresAt": "2026-07-08T12:00:00.0000000+00:00",
"rowCount": 1234,
"md5CheckSum": "0123456789abcdef0123456789abcdef",
"fileSizeBytes": 154321
}
},
"warnings": [],
"errors": []
}/preview/retail-media/insights/share-of-voice
Requests a Share of Voice insight report. This is an asynchronous, non-transactional operation: it does not return the analytic data. It enqueues an export job and returns the created insight report, whose id is then used to poll the insight status endpoint until the report is ready and to download the result from the insight output endpoint.
POST
/
preview
/
retail-media
/
insights
/
share-of-voice
/preview/retail-media/insights/share-of-voice
curl --request POST \
--url https://api.criteo.com/preview/retail-media/insights/share-of-voice \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"type": "ShareOfVoiceInsight",
"attributes": {
"startDate": "2026-06-01T00:00:00.0000000+00:00",
"endDate": "2026-06-07T00:00:00.0000000+00:00",
"aggregationLevel": "category",
"dimensions": [
"date",
"accountId",
"accountName",
"retailerId",
"retailerName",
"brandId",
"brandName",
"campaignId",
"campaignName",
"buyType",
"skuId",
"skuName",
"lineItemId",
"lineItemName",
"pageTypeId",
"pageTypeName",
"productGtin",
"productMpn",
"productCategory",
"servedCategory",
"keyword",
"keywordType",
"campaignType",
"creativeType",
"adFormat",
"creativeName",
"environment",
"budgetModel",
"activationPlatform"
],
"metrics": [
"impressions",
"clicks",
"grossClicks",
"spend",
"cpc",
"ctr",
"cpm",
"roas",
"attributedSales",
"attributedUnits",
"assistedUnits",
"assistedSales",
"exposedUsers",
"impressionShare",
"clickShare",
"invalidClicks"
],
"filters": {
"campaignType": "onsiteSponsoredProducts",
"accountIds": [
"12345"
],
"retailerIds": [
"123"
],
"brandIds": [
"456"
],
"servedCategories": [
"Sports & Outdoors/Footwear/Running Shoes"
],
"keywords": [
"running shoes"
],
"keywordTypes": [
"generic"
],
"budgetModels": [
"criteoBudget"
],
"activationPlatforms": [
"commerceMax"
]
},
"accountId": "12345",
"format": "json-compact"
}
}
}
'import requests
url = "https://api.criteo.com/preview/retail-media/insights/share-of-voice"
payload = { "data": {
"type": "ShareOfVoiceInsight",
"attributes": {
"startDate": "2026-06-01T00:00:00.0000000+00:00",
"endDate": "2026-06-07T00:00:00.0000000+00:00",
"aggregationLevel": "category",
"dimensions": ["date", "accountId", "accountName", "retailerId", "retailerName", "brandId", "brandName", "campaignId", "campaignName", "buyType", "skuId", "skuName", "lineItemId", "lineItemName", "pageTypeId", "pageTypeName", "productGtin", "productMpn", "productCategory", "servedCategory", "keyword", "keywordType", "campaignType", "creativeType", "adFormat", "creativeName", "environment", "budgetModel", "activationPlatform"],
"metrics": ["impressions", "clicks", "grossClicks", "spend", "cpc", "ctr", "cpm", "roas", "attributedSales", "attributedUnits", "assistedUnits", "assistedSales", "exposedUsers", "impressionShare", "clickShare", "invalidClicks"],
"filters": {
"campaignType": "onsiteSponsoredProducts",
"accountIds": ["12345"],
"retailerIds": ["123"],
"brandIds": ["456"],
"servedCategories": ["Sports & Outdoors/Footwear/Running Shoes"],
"keywords": ["running shoes"],
"keywordTypes": ["generic"],
"budgetModels": ["criteoBudget"],
"activationPlatforms": ["commerceMax"]
},
"accountId": "12345",
"format": "json-compact"
}
} }
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: 'ShareOfVoiceInsight',
attributes: {
startDate: '2026-06-01T00:00:00.0000000+00:00',
endDate: '2026-06-07T00:00:00.0000000+00:00',
aggregationLevel: 'category',
dimensions: [
'date',
'accountId',
'accountName',
'retailerId',
'retailerName',
'brandId',
'brandName',
'campaignId',
'campaignName',
'buyType',
'skuId',
'skuName',
'lineItemId',
'lineItemName',
'pageTypeId',
'pageTypeName',
'productGtin',
'productMpn',
'productCategory',
'servedCategory',
'keyword',
'keywordType',
'campaignType',
'creativeType',
'adFormat',
'creativeName',
'environment',
'budgetModel',
'activationPlatform'
],
metrics: [
'impressions',
'clicks',
'grossClicks',
'spend',
'cpc',
'ctr',
'cpm',
'roas',
'attributedSales',
'attributedUnits',
'assistedUnits',
'assistedSales',
'exposedUsers',
'impressionShare',
'clickShare',
'invalidClicks'
],
filters: {
campaignType: 'onsiteSponsoredProducts',
accountIds: ['12345'],
retailerIds: ['123'],
brandIds: ['456'],
servedCategories: ['Sports & Outdoors/Footwear/Running Shoes'],
keywords: ['running shoes'],
keywordTypes: ['generic'],
budgetModels: ['criteoBudget'],
activationPlatforms: ['commerceMax']
},
accountId: '12345',
format: 'json-compact'
}
}
})
};
fetch('https://api.criteo.com/preview/retail-media/insights/share-of-voice', 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/retail-media/insights/share-of-voice",
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' => 'ShareOfVoiceInsight',
'attributes' => [
'startDate' => '2026-06-01T00:00:00.0000000+00:00',
'endDate' => '2026-06-07T00:00:00.0000000+00:00',
'aggregationLevel' => 'category',
'dimensions' => [
'date',
'accountId',
'accountName',
'retailerId',
'retailerName',
'brandId',
'brandName',
'campaignId',
'campaignName',
'buyType',
'skuId',
'skuName',
'lineItemId',
'lineItemName',
'pageTypeId',
'pageTypeName',
'productGtin',
'productMpn',
'productCategory',
'servedCategory',
'keyword',
'keywordType',
'campaignType',
'creativeType',
'adFormat',
'creativeName',
'environment',
'budgetModel',
'activationPlatform'
],
'metrics' => [
'impressions',
'clicks',
'grossClicks',
'spend',
'cpc',
'ctr',
'cpm',
'roas',
'attributedSales',
'attributedUnits',
'assistedUnits',
'assistedSales',
'exposedUsers',
'impressionShare',
'clickShare',
'invalidClicks'
],
'filters' => [
'campaignType' => 'onsiteSponsoredProducts',
'accountIds' => [
'12345'
],
'retailerIds' => [
'123'
],
'brandIds' => [
'456'
],
'servedCategories' => [
'Sports & Outdoors/Footwear/Running Shoes'
],
'keywords' => [
'running shoes'
],
'keywordTypes' => [
'generic'
],
'budgetModels' => [
'criteoBudget'
],
'activationPlatforms' => [
'commerceMax'
]
],
'accountId' => '12345',
'format' => 'json-compact'
]
]
]),
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/retail-media/insights/share-of-voice"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\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/retail-media/insights/share-of-voice")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"type\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.criteo.com/preview/retail-media/insights/share-of-voice")
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\": \"ShareOfVoiceInsight\",\n \"attributes\": {\n \"startDate\": \"2026-06-01T00:00:00.0000000+00:00\",\n \"endDate\": \"2026-06-07T00:00:00.0000000+00:00\",\n \"aggregationLevel\": \"category\",\n \"dimensions\": [\n \"date\",\n \"accountId\",\n \"accountName\",\n \"retailerId\",\n \"retailerName\",\n \"brandId\",\n \"brandName\",\n \"campaignId\",\n \"campaignName\",\n \"buyType\",\n \"skuId\",\n \"skuName\",\n \"lineItemId\",\n \"lineItemName\",\n \"pageTypeId\",\n \"pageTypeName\",\n \"productGtin\",\n \"productMpn\",\n \"productCategory\",\n \"servedCategory\",\n \"keyword\",\n \"keywordType\",\n \"campaignType\",\n \"creativeType\",\n \"adFormat\",\n \"creativeName\",\n \"environment\",\n \"budgetModel\",\n \"activationPlatform\"\n ],\n \"metrics\": [\n \"impressions\",\n \"clicks\",\n \"grossClicks\",\n \"spend\",\n \"cpc\",\n \"ctr\",\n \"cpm\",\n \"roas\",\n \"attributedSales\",\n \"attributedUnits\",\n \"assistedUnits\",\n \"assistedSales\",\n \"exposedUsers\",\n \"impressionShare\",\n \"clickShare\",\n \"invalidClicks\"\n ],\n \"filters\": {\n \"campaignType\": \"onsiteSponsoredProducts\",\n \"accountIds\": [\n \"12345\"\n ],\n \"retailerIds\": [\n \"123\"\n ],\n \"brandIds\": [\n \"456\"\n ],\n \"servedCategories\": [\n \"Sports & Outdoors/Footwear/Running Shoes\"\n ],\n \"keywords\": [\n \"running shoes\"\n ],\n \"keywordTypes\": [\n \"generic\"\n ],\n \"budgetModels\": [\n \"criteoBudget\"\n ],\n \"activationPlatforms\": [\n \"commerceMax\"\n ]\n },\n \"accountId\": \"12345\",\n \"format\": \"json-compact\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"type": "InsightStatus",
"attributes": {
"status": "Success",
"message": "rows_count=1234",
"createdAt": "2026-07-01T12:00:00.0000000+00:00",
"expiresAt": "2026-07-08T12:00:00.0000000+00:00",
"rowCount": 1234,
"md5CheckSum": "0123456789abcdef0123456789abcdef",
"fileSizeBytes": 154321
}
},
"warnings": [],
"errors": []
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
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
200 - application/json
Success
Response returned by the asynchronous insight endpoints, carrying the insight report status.
Was this page helpful?