For the complete documentation index, see llms.txt. This page is also available as Markdown.

API des statistiques globales

Cette section décrit les paramètres de requête et les données de résultat de l’API Global Statistics.

Les routes de l’API des statistiques ont été renommées :

  • /statistics/advertiser/... -> /statistics/a/...

  • /statistics/publisher/... -> /statistics/p/...

L’API Global Statistics n’affiche les requêtes RTB ignorées que pour Date, Sites, Zones, Pays, Régions et Sub IDs.

Paramètre
Description
Remarques
Type

count

Ne retourner que le total des résultats.

entier

facultatif

détaillé

Obtenir plus de détails si possible.

entier

facultatif

timezone

Paramètre de fuseau horaire pour le filtre 'hour' et 'group_by'

chaîne

facultatif

totals

Indique s’il faut ajouter les totaux à la réponse ou non.

entier

facultatif

filter

Filtres permettant de restreindre les valeurs renvoyées par une requête de statistiques

objet

facultatif

group_by

Liste des valeurs de group by à appliquer dans les données. Quatre au maximum sont autorisées.

tableau

obligatoire

order_by

Ordre des résultats selon un ou plusieurs champs spécifiques. Deux au maximum sont autorisés.

tableau

facultatif

projection

Sous-structures individuelles que l’utilisateur souhaite voir renvoyées dans la réponse.

tableau

facultatif

limit

Nombre d’enregistrements à renvoyer dans cette réponse.

entier

facultatif

offset

Position à partir de laquelle récupérer les enregistrements.

entier

facultatif

Nombre de paramètres

Propriété

count

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 :

Paramètre detailed

Propriété

détaillé

Type

facultatif

Type de variable

entier

Valeur par défaut

0

Valeurs disponibles

[0, 1]

Description

Indique s’il faut renvoyer des informations détaillées ou non.

Exemple :

Paramètre timezone

Paramètre de fuseau horaire pour hour le filtre et group_by.

Propriété

timezone

Type

facultatif

Type de variable

chaîne

Valeur par défaut

America/New_york

Valeurs disponibles

Définir le champ de fuseau horaire de / collections / timezones

Description

REMARQUE : les fuseaux horaires ne sont pertinents que lorsque nous interrogeons des données horaires ; pour les données non horaires, cela n’a aucun effet.

Exemple :

Paramètre totals

Propriété

totals

Type

facultatif

Type de variable

entier

Valeur par défaut

0

Valeurs disponibles

[0,1]

Description

Indique s’il faut ajouter les totaux à la réponse ou non.

Exemple :

Paramètre filter

Propriété

filter

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_group_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 selon certains paramètres.

Filtre : country_iso

Propriété

country_iso

Type

facultatif

Type de variable

chaîne

Valeur par défaut

-

Valeurs disponibles

Voir la propriété iso3 du point de terminaison /collections/countries

Description

Liste des codes ISO 3

Exemple :

Filtre date_from, date_to

Le date_from et date_to ces paramètres contrôlent la période sur laquelle vous souhaitez récupérer les informations de statistiques.

  • date_from : date de début de la plage pour les statistiques, (début du mois par défaut),

  • date_to : date de fin de la plage pour les statistiques, (aujourd’hui par défaut)

Propriété

date_from, date_to

Type

facultatif

Type de variable

chaîne

Valeur par défaut

Les dates utilisent par défaut le mois en cours.

Valeurs disponibles

YYYY-mm-dd

Description

Plage date_from/date_to pour les statistiques. Format YYYY-mm-dd

Exemple :

Les fuseaux horaires ne sont pertinents que lorsque nous interrogeons des données horaires ; pour les données non horaires, cela n’a aucun effet.

Filtre : advertiser_ad_type_id, campaign_group_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_group_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

tableau

Type d’éléments

entier

Valeur par défaut

-

Valeurs disponibles

Propriétés relatives OU collections

Description

Liste des identifiants d’entité

Exemple :

Filtre : exclude_deleted

Propriété

exclude_deleted

Type

facultatif

Type de variable

entier

Valeur par défaut

0

Valeurs disponibles

[0, 1]

Description

Indique s’il faut exclure les campagnes supprimées ou non.

Exemple :

Filtre : adblock

Propriété

adblock

Type

facultatif

Type de variable

chaîne

Valeur par défaut

"all"

Valeurs disponibles

"adblock", "all", "standard"

Description

Indique s’il faut inclure ou non les zones adblock.

Exemple :

Filtre : site_hostname

Propriété

site_hostname

Type

facultatif

Type de variable

chaîne

Valeur par défaut

-

Valeurs disponibles

Les caractères valides pour les noms d’hôte sont les lettres de a à z, les chiffres de 0 à 9, le tiret et le point.

Description

Filtrer par nom d’hôte du site.

Exemple :

Filtre : size

Propriété

size

Type

facultatif

Type de variable

chaîne

Valeur par défaut

-

Valeurs disponibles

Les caractères valides pour size sont les chiffres de 0 à 9 et le caractère x. Exemple 300x100

Description

Filtrer par taille

Exemple :

Paramètre group_by

Propriété

group_by

Type

obligatoire

Type de variable

tableau

Type d’éléments

chaîne

Valeur par défaut

-

Valeurs disponibles pour les annonceurs

[”adblock”, “advertiser_ad_type_id”, browser_id”, “idcampaign_group“, “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”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “size”, “sub”, “zone_id”, “week”, “month”, “quarter”, “year”]

Description

Liste des sous-requêtes à inclure pour ajouter des données supplémentaires dans la réponse.

Exemple :

Paramètre order_by

Propriété
order_by

Type

facultatif

Type de variable

tableau

Type d’éléments

chaîne

Valeur par défaut

-

Valeurs des champs de métriques disponibles

[“cpc”, “cpc”, “cpm”, “cpv”, “ctr”, “clicks”, “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 champs 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”]

Valeurs de champs disponibles en fonction 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 d’ordre disponibles

[“asc”, “desc”]

Description

Liste des options de tri disponibles

Conseils:

  • Les champs de métriques sont toujours disponibles pour être utilisés comme champ de tri.

  • Pour trier selon une valeur spécifique (par exemple par “browser_id”), vous devez l’inclure dans le paramètre “group_by”.

Les valeurs “g1”, “ecpa1” ne sont disponibles que lorsque l’utilisateur dispose du suivi des conversions (Goals). Tous les objectifs sont associés à un numéro de série (g1, g2, …gx). Les valeurs eCPA sont donc ecpa1, ecpa2, …ecpax.

Exemple :

Exemple d’organisation chronologique des résultats de campagne ; la valeur “date” doit être incluse à la fois dans “group_by” et “order_by” :

Paramètre projection

Le paramètre projection indique 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’éléments

tableau

Valeur par défaut

toutes les options, voir ci-dessous

Valeurs de champs disponibles pour les annonceurs

[“base”, “rtb”, “video”, “goals*”]

Valeurs de champs disponibles pour les éditeurs

[“base”, “rtb”, “video”, “wpn”]

*Certains champs "goal", comme "profit" et "roi", sont calculés à partir du coût de la campagne, vous devez donc également utiliser le champ "base" si vous souhaitez recevoir les métriques "goals" correctes.

Exemples :

Afin de recevoir toutes les métriques possibles en tant qu’annonceur, utilisez :

Afin de recevoir toutes les métriques possibles en tant qu’éditeur, utilisez :

Vous pouvez également préciser les métriques dans chaque champ de projection :

Le seul champ qui ne permet pas de projection de métriques spécifique est "goals"

Paramètre limit

Nombre d’enregistrements à renvoyer dans cette réponse.

Propriété

limit

Type

facultatif

Type de variable

entier

Valeur par défaut

50

Exemple :

Paramètre offset

Position à partir de laquelle récupérer les enregistrements.

Propriété

offset

Type

facultatif

Type de variable

entier

Valeur par défaut

0

Exemple

Exemple 1

Statistique de campagne annonceur avec filtrage.

Requête :

Réponse :

Exemple 2

Statistique de l’annonceur par date pour le mois en cours, triée par impressions.

Requête :

Réponse :

Exemple 3

Statistique de l'éditeur par date et region_id, triée par impressions.

Requête :

Réponse :

Exemple 4

Statistique de l'éditeur par site_id avec projection.

Requête :

Réponse

Mis à jour

Ce contenu vous a-t-il été utile ?