API sur les statistiques mondiales
Cette section décrit les paramètres de demande de l'API Statistiques globales et les données de résultat.
Note : Les routes de l'API statistiques ont été renommées :
- /statistiques/annonceurs/... -> /statistiques/a/...
- /statistiques/éditeur/... -> /statistiques/p/...
Remarque : L'API Global Statistics n'affiche que les requêtes RTB ignorées pour les dates, les sites, les zones, les pays, les régions et les sous-identifiants.
Paramètres | Description | Notes | Type |
---|---|---|---|
compter | Ne retourner que le total des résultats. | entier | facultatif |
détaillée | Obtenez plus de détails si possible. | entier | facultatif |
fuseau horaire | Réglage du fuseau horaire pour le filtre 'hour' et 'group_by' | chaîne de caractères | facultatif |
totaux | Indique si les totaux doivent être ajoutés à la réponse ou non. | entier | facultatif |
filtre | Filtres permettant de restreindre les valeurs renvoyées par une requête statistique | objet | facultatif |
group_by | Une liste de valeurs de regroupement à appliquer aux données. Quatre valeurs au maximum sont autorisées. | réseau | obligatoire |
order_by | Classement des résultats par champ(s) spécifique(s). Deux au maximum sont autorisés. | réseau | facultatif |
projection | Sous-structures individuelles que l'utilisateur souhaite voir renvoyer dans la réponse. | réseau | facultatif |
limite | Le nombre d'enregistrements à renvoyer dans cette réponse. | entier | facultatif |
compensation | La position à partir de laquelle les enregistrements doivent être récupérés. | entier | facultatif |
Nombre de paramètres
Propriété | compter |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 0 |
Valeurs disponibles | [0, 1] |
Description | Ne retourner que le total des résultats. |
Exemple :
{
"count": 1
}
Paramètre détaillé
Propriété | détaillée |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 0 |
Valeurs disponibles | [0, 1] |
Description | Renvoi ou non d'informations détaillées. |
Exemple :
{
"detailed": 1
}
Paramètre timezone
Réglage du fuseau horaire pour le filtre hour
et group_by
.
Propriété | fuseau horaire |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | Amérique/New_york |
Valeurs disponibles | Définir le champ du fuseau horaire de / collections / fuseaux horaires |
Description | REMARQUE : les fuseaux horaires ne sont pertinents que pour les requêtes basées sur des données horaires ; pour les données non horaires, cette option n'est pas envisageable. |
Exemple :
{
"timezone": "Europe/Dublin"
}
Totaux des paramètres
Propriété | totaux |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 0 |
Valeurs disponibles | [0,1] |
Description | Indique si les totaux doivent être ajoutés à la réponse ou non. |
Exemple :
{
"totals": 1
}
Filtre de paramètres
Propriété | filtre |
Type | facultatif |
Type de variable | objet |
Option disponible pour les annonceurs | ["adblock", "advertiser_ad_type_id", "browser_id", "carrier_id", "category_id", "country_iso", "date_from", "date_to", "device_id", "device_type_id", hour", "language_id", "operating_system_id", "region_id", "site_hostname", "site_id", "size", "sub", "zone_id", "campaign_id", "exclude_deleted", "offer_id", "offer_landing_page_id", "variation_id"] |
Option disponible pour les éditeurs | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "date_from", "date_to", "device_id", "device_type_id", "hour", "language_id", "operating_system_id", "region_id", "site_hostname", "site_id", "zone_id", "publisher_ad_type_id", "size", "sub"] |
Description | Filtrer en fonction de certains paramètres. |
Filtre : country_iso
Propriété | pays_iso |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | - |
Valeurs disponibles | Voir la propriété iso3 du point final /collections/countries |
Description | Liste des codes ISO 3 |
Exemple :
{
"filter": {
"country_iso": ["ESP", "IRL"]
}
}
Filtre date_from
, date_to
Les paramètres date_from
et date_to
contrôlent la fenêtre sur laquelle vous souhaitez récupérer les informations statistiques.
- date_from : Date à partir de laquelle les statistiques sont établies (par défaut, début du mois),
- date_to : Date à laquelle les statistiques doivent être établies (par défaut, aujourd'hui).
Propriété | date_from, date_to |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | Les dates sont par défaut le mois en cours. |
Valeurs disponibles | YYYY-mm-dd |
Description | Plage de dates de/à pour les statistiques. Format AAAA-mm-jj |
Exemple :
{
"filter": {
"date_from": "2019-02-25",
"date_to": "2019-02-28"
}
}
Les fuseaux horaires ne sont pertinents que pour les requêtes basées sur des données horaires ; pour les données non horaires, cela ne sert à rien.
Filtre : advertiser_ad_type_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, publisher_ad_type_id
Propriété | advertiser_ad_type_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, advertiser_ad_type_id, publisher_ad_type_id |
Type | facultatif |
Type de variable | réseau |
Type d'articles | entier |
Valeur par défaut | - |
Valeurs disponibles | Propriétés relatives OU collections |
Description | Liste des identifiants d'entités |
Exemple :
{
"filter": {
"campaign_id": [123, 456],
"browser_id": [789]
}
}
Filtre : exclude_deleted
Propriété | exclure_supprimer |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 0 |
Valeurs disponibles | [0, 1] |
Description | Exclure ou non les campagnes supprimées. |
Exemple :
{
"filter": {
"exclude_deleted": 1
}
}
Filtre : adblock
Propriété | adblock |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | "tous" |
Valeurs disponibles | "adblock", "all", "standard" |
Description | Inclure ou non les zones de blocage des publicités. |
Exemple :
{
"filter": {
"adblock": "standard"
}
}
Filtre : site_hostname
Propriété | nom d'hôte du site |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | - |
Valeurs disponibles | Les caractères valables pour les noms d'hôtes sont les lettres de a à z, les chiffres de 0 à 9, le trait d'union et le point. |
Description | Filtre sur le nom d'hôte du site. |
Exemple :
{
"filter": {
"site_hostname": ["www.example.com", "www.example-site.org"]
}
}
Filtre : size
Propriété | taille |
Type | facultatif |
Type de variable | chaîne de caractères |
Valeur par défaut | - |
Valeurs disponibles | Les caractères valables pour la taille sont les chiffres de 0 à 9 et le caractère x. Exemple 300x100 |
Description | Filtrer par taille |
Exemple :
{
"filter": {
"size": ["300x100"]
}
}
Paramètre group_by
Propriété | group_by |
Type | obligatoire |
Type de variable | réseau |
Type d'articles | chaîne de caractères |
Valeur par défaut | - |
Valeurs disponibles pour les annonceurs | ["adblock", "advertiser_ad_type_id", browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "date", "hour", "device_id", "device_type_id", "language_id", "operating_system_id", "region_id", "site_id", "sub", "zone_id", "week", "month", "quarter", "year", "offer_id", "offer_landing_page_id", "site_hostname", "size", "variation_id"] |
Valeurs disponibles pour les éditeurs | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "date", "device_id", "device_type_id", "hour", "language_id", "operating_system_id", "publisher_ad_type_id" "region_id", "site_id", "size", "sub", "zone_id", "week", "month", "quarter", "year"] |
Description | Une liste de sous-demandes pour inclure des données supplémentaires dans la réponse. |
Exemple :
{
"group_by": [
"browser",
"date"
]
}
Paramètre order_by
Propriété | order_by |
---|---|
Type | facultatif |
Type de variable | réseau |
Type d'articles | chaîne de caractères |
Valeur par défaut | - |
Valeurs disponibles pour les champs de métriques | ["cpc", "cpc", "cpm", "cpv", "ctr", "clics", "impressions", "video_impressions", "video_views", "vtr", "rtb_win_ratio", "rtb_avg_total_time", "rtb_skipped", "rtb_bid_response_ratio", "rtb_avg_cpm", "rtb_timeouts_ratio", "rt_errors_ratio", "rtb_no_bid_ratio", "rtb_skipped_ratio"]. |
Valeurs de champ disponibles en fonction de `group_by' pour les annonceurs | ["adblock", "browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "device_id", "date", "device_type_id", "hour", "ecpa1", "g1", "language_id", "month", "offer_id", "offer_landing_page_id", "operating_system_id", "quarter", "region_id", "site_hostname", "site_id", "sub", "variation_id", "week", "year" , "zone_id"] |
Les valeurs de champ disponibles dépendent de `group_by' pour les éditeurs | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "device_id", "date", "device_type_id" , "hour", "language_id", "month", "operating_system_id", "quarter", "region_id", "site_id", "sub", "week", "year", "zone_id"] |
Valeurs de commande disponibles | ["asc", "desc"] |
Description | Une liste des options de commande disponibles |
Conseils :
- Les champs de métriques sont disponibles en permanence et peuvent être utilisés comme champs de classement.
- Pour commander par une valeur spécifique (par exemple par "browser_id"), vous devez l'inclure dans le paramètre "group_by".
Les valeurs "g1" et "ecpa1" ne sont disponibles que si l'utilisateur dispose du suivi des conversions (objectifs). Tous les objectifs sont associés à un numéro de série (g1, g2, ...gx). Les valeurs eCPA sont donc ecpa1, ecpa2, ...ecpax.
Exemple :
{
"order_by": [
{
"field": "impressions",
"order": "desc"
}
]
}
Exemple : pour organiser les résultats de la campagne par ordre chronologique, la "date" doit être incluse à la fois dans "group_by" et "order_by" :
{
"group_by": [
"campaign_id",
"date"
],
"order_by":[
{
"field": "date",
"order": "asc"
}
]
}
Projection des paramètres
Le paramètre de projection reflète ce qui sera renvoyé dans la charge utile résultante. S'il n'est pas spécifié, toutes les sous-structures seront renvoyées.
Propriété | projection |
---|---|
Type | facultatif |
Type de variable | objet |
Type d'articles | réseau |
Valeur par défaut | toutes les options, voir ci-dessous |
Valeurs des champs disponibles pour les annonceurs | ["base", "rtb", "video", "goals*"] |
Valeurs disponibles pour les éditeurs | ["base", "rtb", "video", "wpn"] |
*Certains champs "objectifs", comme "profit" et "roi", sont calculés sur la base du coût de la campagne. Vous devez donc également utiliser le champ "base" si vous voulez recevoir les mesures "objectifs" correctes.
Exemples :
Afin de recevoir tous les indicateurs possibles en tant qu'annonceur, utilisez :
{
"projection": {
"base": ["*"],
"video": ["*"],
"goals": ["*"],
"rtb": ["*"]
}
}
Afin de recevoir tous les indicateurs possibles en tant qu'éditeur, utilisez :
{
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
}
}
Vous pouvez également spécifier les métriques dans chaque champ de projection :
{
"projection": {
"base": ["impressions","clicks","cost","revenue","cpc","cpm","ctr"],
"video": ["impressions","views","cpv","vtr"],
"rtb": ["total_time","queries","value","success","no_bid","skipped","errors","timeouts","wins","win_ratio"],
//only for Publishers
"wpn": ["subscriptions","unsubscriptions","sent"]
}
}
Le seul champ qui ne permet pas la projection de mesures spécifiques est celui des "objectifs"
Limite des paramètres
Le nombre d'enregistrements à renvoyer dans cette réponse.
Propriété | limite |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 50 |
Exemple :
{
"limit": 25
}
Décalage des paramètres
La position à partir de laquelle les enregistrements doivent être récupérés.
Propriété | compensation |
Type | facultatif |
Type de variable | entier |
Valeur par défaut | 0 |
Exemple
{
"offset": 150
}
Exemple 1
Statistiques de la campagne de l'annonceur avec filtrage.
Demande :
{
"detailed": true,
"totals": 1,
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["campaign_id"],
"order_by": [
{
"field": "campaign_id",
"order": "desc"
}
]
"projection": {
"base": ["*"],
"video": ["*"],
"rtb": ["*"]
},
"limit": 2,
"offset": 0
}
Réponse :
{
"request_metadata": {
"count": 4,
"limit": 2,
"offset": 0
},
"result": [
{
"clicks": 0,
"cost": 1.3302,
"cpc": 0,
"cpm": 0.45586017820425,
"ctr": 0,
"group_by": {
"campaign_id": {
"active": "1",
"campaign_ad_type_name": "Popunders",
"id": "1234567",
"name": "Ron Mainstream Campaign "
}
},
"impressions": 2918,
"rtb": {
"avg_cpm": 0.15582967823432,
"avg_total_time": 89.522714492492,
"errors": 112,
"errors_ratio": 0.011368411650186,
"no_bid": 870594,
"no_bid_ratio": 88.368490823053,
"queries": 985186,
"response_ratio": 11.57101298638,
"skipped": 0,
"skipped_ratio": 0,
"success": 984590,
"timeouts": 484,
"timeouts_ratio": 0.049127778916875,
"total_time": 88196525,
"value": 1776.396,
"win_ratio": 0.29842080581738,
"wins": 2940
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 18.1621655,
"cpc": 0,
"cpm": 1.8273634671496,
"ctr": 0,
"group_by": {
"campaign_id": {
"active": "1",
"campaign_ad_type_name": "Popunders",
"id": "7654321",
"name": "Ron Mainstream Campaign Test"
}
},
"impressions": 9939,
"rtb": {
"avg_cpm": 1.4753505300475,
"avg_total_time": 88.777190144965,
"errors": 46,
"errors_ratio": 0.0014192869995779,
"no_bid": 3209674,
"no_bid_ratio": 99.031490893114,
"queries": 3241064,
"response_ratio": 0.8964340105595,
"skipped": 0,
"skipped_ratio": 0,
"success": 3238728,
"timeouts": 2290,
"timeouts_ratio": 0.070655809326814,
"total_time": 287732555,
"value": 4286.48343,
"win_ratio": 0.30665855410445,
"wins": 9939
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
],
"result_total": {
"clicks": 0,
"cost": 74.0473595,
"cpc": 0,
"cpm": 2.0864288391096,
"ctr": 0,
"impressions": 35490,
"rtb": {
"avg_cpm": 0.23441613972984,
"avg_total_time": 87.995789332859,
"errors": 539,
"errors_ratio": 0.0049868154705264,
"no_bid": 9771471,
"no_bid_ratio": 90.405422546568,
"queries": 10808501,
"response_ratio": 9.5135301370653,
"skipped": 0,
"skipped_ratio": 0,
"success": 10799741,
"timeouts": 8221,
"timeouts_ratio": 0.07606050089647,
"total_time": 951102577,
"win_ratio": 0.32861171035651,
"wins": 35518
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
}
Exemple 2
Statistiques de l'annonceur par date pour le mois en cours, classées par impressions.
Demande :
{
"group_by": ["date"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
]
"projection": {
"base": ["*"],
"video": ["*"],
"rtb": ["*"]
}
}
Réponse :
{
"request_metadata": {
"count": 3,
"limit": 50,
"offset": 0
},
"result": [
{
"clicks": 0,
"cost": 624.2439917,
"cpc": 0,
"cpm": 1.0978015474007,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-02"
}
},
"impressions": 568631,
"rtb": {
"avg_cpm": 0.31273156270632,
"avg_total_time": 114.34705591799,
"errors": 4143,
"errors_ratio": 0.0076578188576312,
"no_bid": 48085697,
"no_bid_ratio": 88.8804144989,
"queries": 54101567,
"response_ratio": 10.971772776933,
"skipped": 0,
"skipped_ratio": 0,
"success": 54021598,
"timeouts": 75826,
"timeouts_ratio": 0.14015490530986,
"total_time": 6186354907,
"value": 185634.35958,
"win_ratio": 1.1633248996281,
"wins": 629377
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 622.1688691,
"cpc": 0,
"cpm": 1.1800128762878,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-01"
}
},
"impressions": 527256,
"rtb": {
"avg_cpm": 0.27775587567531,
"avg_total_time": 118.91585420372,
"errors": 2954,
"errors_ratio": 0.0078196779097434,
"no_bid": 32641750,
"no_bid_ratio": 86.407573260111,
"queries": 37776492,
"response_ratio": 13.412992397494,
"skipped": 0,
"skipped_ratio": 0,
"success": 37708708,
"timeouts": 64830,
"timeouts_ratio": 0.17161466448499,
"total_time": 4492223815,
"value": 140737.73563,
"win_ratio": 1.4077723257099,
"wins": 531807
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 441.843491,
"cpc": 0,
"cpm": 0.96186339096399,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-03"
}
},
"impressions": 459362,
"rtb": {
"avg_cpm": 0.26462497173837,
"avg_total_time": 116.9210100884,
"errors": 2183,
"errors_ratio": 0.0059889808787451,
"no_bid": 32174177,
"no_bid_ratio": 88.268681100486,
"queries": 36450275,
"response_ratio": 11.500815837466,
"skipped": 0,
"skipped_ratio": 0,
"success": 36366256,
"timeouts": 81836,
"timeouts_ratio": 0.22451408116948,
"total_time": 4261802971,
"value": 110932.87869,
"win_ratio": 1.2852029237091,
"wins": 468460
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
]
}
Exemple 3
Statistiques de l'éditeur par date et par region_id, classées par impressions.
Demande :
{
"detailed": true,
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["date", "region_id"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
],
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
}
"limit": 30,
"offset": 0
}
Réponse :
{
"request_metadata": {
"count": 2,
"limit": 30,
"offset": 0
},
"result": [
{
"clicks": 3087,
"cpc": 0.033842716164561,
"cpm": 0.069188574849649,
"ctr": 0.20444155402072,
"group_by": {
"date": {
"date": "2019-03-11"
},
"region_id": {
"country_iso": "USA",
"country_long_name": "United States of America",
"country_short_name": "United States",
"id": 5332921,
"name": "California"
}
},
"impressions": 1494954,
"revenue": 104.4724648,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.038451404048583,
"impressions": 15013,
"views": 2717,
"vtr": 18.097648704456
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
},
{
"clicks": 3071,
"cpc": 0.03151133555845,
"cpm": 0.066658890819906,
"ctr": 0.21153940205505,
"group_by": {
"date": {
"date": "2019-03-10"
},
"region_id": {
"country_iso": "USA",
"country_long_name": "United States of America",
"country_short_name": "United States",
"id": 5332921,
"name": "California"
}
},
"impressions": 1436818,
"revenue": 96.7713115,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.036216808196108,
"impressions": 14921,
"views": 2672,
"vtr": 17.907646940554
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
}
]
}
Exemple 4
Statistiques de l'éditeur par identifiant de site avec projection.
Demande :
{
"detailed": true,
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
},
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["site_id"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
],
"limit": 30,
"offset": 0
}
Réponse
{
"request_metadata": {
"count": 2,
"limit": 30,
"offset": 0
},
"result": [
{
"clicks": 14320,
"cpc": 0.028298959692737,
"cpm": 0.057945765404939,
"ctr": 0.20476288186597,
"group_by": {
"site_id": {
"id": "11223344",
"name": "nice-example.com"
}
},
"impressions": 6916414,
"revenue": 405.2411028,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.031519102652252,
"impressions": 77041,
"views": 12857,
"vtr": 16.688516504199
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
},
{
"clicks": 14148,
"cpc": 0.028769196296296,
"cpm": 0.063791981699323,
"ctr": 0.22173710048179,
"impressions": 6314909,
"revenue": 407.0265892,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.036406671663685,
"impressions": 65620,
"views": 11180,
"vtr": 17.037488570558
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
}
]
}