API de Reporting

remarque

Avis de Dépréciation

Les APIs de Reporting Rokt documentées ci-dessous sont désormais obsolètes et ne recevront plus de nouvelles mises à jour ou améliorations. Nous encourageons fortement tous les clients à migrer vers l'API de Requête Rokt, qui offre une plus grande flexibilité, des performances améliorées et un support étendu des métriques/dimensions pour les cas d'utilisation de reporting.

Pourquoi ce changement ?

L'API de Requête fournit une interface modernisée et unifiée pour récupérer les données de campagnes et de transactions, permettant :

Un regroupement dynamique avec plusieurs dimensions
Une structure de requête simplifiée et cohérente
Des capacités de filtrage améliorées
Un support évolutif pour les futures métriques et dimensions de reporting

Support de Migration

Pour vous aider dans votre migration, veuillez vous référer à notre Guide de Migration de l'API de Requête, qui associe chaque point de terminaison de reporting hérité à son corps de requête API de Requête correspondant. Ce guide inclut :

Des exemples un-à-un pour remplacer les appels API actuels
Des instructions sur la traduction des paramètres (par exemple, ID de compte, fuseau horaire, devise)
Des informations sur les points de terminaison de métadonnées actuellement non pris en charge

⚠️ Remarque : Certains points de terminaison de métadonnées hérités (Campagne, Audience et Métadonnées Créatives) ne sont pas encore pris en charge par l'API de Requête. Continuez à utiliser ces points de terminaison hérités jusqu'à nouvel ordre.

Aperçu

L'API de Reporting Rokt permet aux annonceurs et aux partenaires de récupérer leurs données de performance depuis la plateforme Rokt pour créer leurs propres rapports et tableaux de bord. C'est une API basée sur HTTP qui peut être utilisée pour interroger et intégrer de manière programmatique les données Rokt dans des applications métier externes. L'API fonctionne avec n'importe quel langage qui supporte les requêtes HTTP. Presque toutes les requêtes sont envoyées à l'URL hôte https://api.rokt.com.

Pour garder vos données sûres et sécurisées, l'API de Reporting Rokt utilise des jetons d'accès pour authentifier les requêtes. Les jetons d'accès permettent à Rokt d'identifier les applications clientes et le type de données accédées, ainsi que d'empêcher les applications malveillantes d'accéder à des données qu'elles ne devraient pas pouvoir voir.

L'authentification à l'API est effectuée via OAuth 2.0. Pour effectuer un appel API réussi, vous devez utiliser un ID d'application (App ID) et un Secret d'application (App Secret) pour obtenir un jeton d'accès. Les requêtes API sans authentification échoueront. L'API de Reporting Rokt vous permet uniquement de récupérer des données des comptes auxquels vos identifiants utilisateur ont accès.

Version

Pour les premiers utilisateurs utilisant la version Alpha Release de l'API, assurez-vous que "rokt-version":"alpha-20200701" est utilisé dans l'en-tête de votre requête API afin de minimiser les éventuels changements incompatibles. Si aucun en-tête rokt-version n'est utilisé, votre requête d'endpoint pointera toujours vers la version LATEST de l'API de Reporting Rokt.

Authentification

L'API de Reporting Rokt utilise l'approche OAuth 2.0 pour l'intégration client. Voir le flux d'informations d'identification OAuth 2.0 pour plus de détails. Vous devez utiliser votre Rokt App ID et App Secret pour accéder à l'API de Reporting Rokt.

Les étapes pour générer l'App ID et l'App Secret sont expliquées ci-dessous. Vous pouvez générer des informations d'identification pour l'API d'événements Rokt avec ces mêmes étapes.

Vous devez utiliser ces informations d'identification de l'application client dans les interactions REST avec l'API de Reporting Rokt.

Génération de l'ID d'application et du secret d'application

Connectez-vous à One Platform sur my.rokt.com.
Accédez à Paramètres du profil sous l'icône de votre compte en bas à gauche.
Faites défiler jusqu'à la section Générer des identifiants API personnels.
Entrez le nom de votre application.
Cliquez sur Générer.
Vos identifiants pour l'API de Reporting (Reporting API) et l'API d'événements (Event API) seront générés immédiatement et ressembleront à ceci :
```
AppId: "40svbin0d194subpohl079rhck"
AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"
```
Stockez l'ID d'application et le secret d'application dans un endroit sécurisé. Vous n'aurez plus accès au secret d'application après cette session.
Vous pouvez utiliser ces identifiants immédiatement.

Vous devez garder les identifiants confidentiels afin de protéger votre compte et ils ne doivent jamais être envoyés par e-mail. Ne les partagez pas en dehors de votre organisation, même si une demande semble provenir de Rokt. Personne représentant légitimement Rokt ne vous demandera jamais votre secret d'application.

Obtention d'un jeton d'accès

Un jeton d'accès est nécessaire pour appeler n'importe quel endpoint de l'API de Reporting de Rokt. Les jetons d'accès permettent à Rokt d'identifier les applications clientes, le type de données auquel chaque application cliente accède, et d'empêcher les applications malveillantes d'accéder à des données auxquelles elles n'ont pas droit.

L'authentification à l'API est effectuée via OAuth 2.0. Pour exécuter un appel API réussi, vous devrez utiliser un App ID et un App Secret pour obtenir un jeton d'accès qui devra être utilisé dans tous les appels API. L'App ID et l'App Secret peuvent être générés sur la page Paramètres du profil dans One Platform comme décrit ci-dessus.

Les requêtes API sans authentification ou avec une authentification incorrecte échoueront. L'API renverra soit un code d'erreur 400 soit 403. Depuis l'API de Reporting de Rokt, vous ne pouvez récupérer des données que des comptes auxquels vos identifiants utilisateur ont accès.

Les jetons d'accès sont générés sur la base de l'App ID et de l'App Secret créés à l'étape précédente. Le jeton d'accès est valable une heure. Pendant cette heure, le jeton d'accès peut être utilisé pour appeler tous les endpoints de l'API de Reporting de Rokt. Avant qu'il n'expire, vous devez régénérer le jeton d'accès sur la base des identifiants de l'application cliente.

Pour obtenir le jeton d'accès, un endpoint est exposé dans l'API de Reporting de Rokt :

POST https://api.rokt.com/auth/oauth2/token

Paramètres de requête dans l'en-tête

Clé	Dans	Description	Obligatoire?	Exemple
`Authorization`	header	`app_id` et `app_secret` doivent être passés dans l'en-tête d'autorisation via l'autorisation HTTP de base et peuvent être générés sous Profile Settings dans One Platform; le contenu de l'en-tête est `Basic base64encode(app_id:app_secret)`	Oui	Basic base64encocde(12345:abcde)
`Content-Type`	header	Le type de média de la requête doit toujours être `application/x-www-form-urlencoded`	Oui	application/x-www-form-urlencoded

Paramètres de requête dans le corps

Clé	Dans	Description	Obligatoire?	Exemple
`grant_type`	body	Doit être `client_credentials`	Oui	client_credentials

Exemple de requête réussie

Exemple de requête :

curl -vX POST  https://api.rokt.com/auth/oauth2/token \
	-H 'Authorization: Basic ${AuthToken}' \
	-H 'Content-Type: application/x-www-form-urlencoded' \
	-d 'grant_type=client_credentials'

Exemple de réponse :

{
    "access_token": "eyJraWQiOiJPVUpHT1RjM09FWXROakkzUlMwME5UUkJMVGxCTkRrdFJqWXdOVVV3UkRNNE1FTTJDZz09IiwiYWxnIjoiSFMyNTYifQ.eyJzdWIiOiJkZW1vIiwidG9rZW5fdXNlIjoiYWNjZXNzIiwic2NvcGUiOiJyZXBvcnQtYXBpL3JlYWQtcmVwb3J0LWFwaSIsImF1dGhfdGltZSI6MTU4NTExMDA0MSwiaXNzIjoiaHR0cHM6Ly9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS91cy13ZXN0LTJfZG93Tlp1elRYIiwiZXhwIjoxNTg1MTEzNjQxLCJpYXQiOjE1ODUxMTAwNDEsInZlcnNpb24iOjIsImp0aSI6IkYwNzY5RDVDLTRDNTAtNDVDOC04OTcyLTI4MkUwODlDMkFFOSIsImNsaWVudF9pZCI6ImRlbW8ifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA",
    "expires_in": 3600,
    "token_type": "Bearer"
}

Points de terminaison de l'API

Appeler un point de terminaison de l'API

En utilisant le jeton d'accès de l'étape précédente, vous pouvez maintenant appeler les points de terminaison sur l'API de Reporting de Rokt. Notez que le jeton doit être envoyé en tant que jeton Bearer dans l'en-tête Authorization.

Exemple de requête API :

GET https://api.rokt.com/reporting/performance-reports/partner/1/stats?dateStart=2020-02-05&dateEnd=2020-02-12&
Authorization=Bearer "eyJraWQiOiJNMDJyQmZzT3pNKzRVMjhHRjVuaDdIREphWlIwaytDMlwvNFl5dXYxZ2N0ST0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI0MHN2YmluMGQxOTRzdWJwb2hsMDc5cmhjayIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoicmVwb3J0LWFwaVwvcmVhZC1yZXBvcnQtYXBpIiwiYXV0aF90aW1lIjoxNTg1MTEwMDQxLCJpc3MiOiJodHRwczpcL1wvY29nbml0by1pZHAudXMtd2VzdC0yLmFtYXpvbmF3cy5jb21cL3VzLXdlc3QtMl9kb3dOWnV6VFgiLCJleHAiOjE1ODUxMTM2NDEsImlhdCI6MTU4NTExMDA0MSwidmVyc2lvbiI6MiwianRpIjoiZDFlNjgyMDYtNWVlNy00NThjLTkwODYtZjAwYjhiMjEzYjJhIiwiY2xpZW50X2lkIjoiNDBzdmJpbjBkMTk0c3VicG9obDA3OXJoY2sifQ.NOJIx7qLHFVXqKNZfJKsJlwitOvbHOLdknQ\_D33WjYe8O9ZE08t7LFgs7ANiwBicN5ejmdS7iND0cth5ViUWK5MKZxvLKI6dPG5RljegfpZJtGKqDT\_MFfpayvcOlkkZc5yRw9Bcgz\_fW2ha7q6BGRsUb-e9DZ0Pcb5zL\_HbRLbnvlhYCYi9rPmYOYG6BronvLwB8sg2kVubLQGn\_ASbK\_FW8bKPhqH4BL2\_JunGBzUKJPL9yNvOnFy7VKwlvH1OKUqKlCYbewOtUd1utcMNIb\_AbSGRtzJKslbE5VwQtL5bZ34kOCNH07gSolSGvqqw4dyxU4l0QSVXVmqgVYdKfA"

GET Account Campaigns Breakdown

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour l'activité totale d'un compte annonceur Rokt Ads pour une période donnée, un fuseau horaire et une devise. Par défaut, le résultat est ventilé par campagne, mais vous pouvez également ventiler l'activité par pays.

Description

Appelez ce point de terminaison API pour recevoir des données au niveau du compte ventilées par camapignid pour une période, un fuseau horaire et une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :

country

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/breakdown

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de dates/heure demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de dates/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Fuseau horaire souhaité au format Olson	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path	Votre ID de compte Rokt. Trouvé sur One Platform ou fourni par votre gestionnaire de compte.	true

Réponse

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "referrals": 0,
 "campaignCountries": 0,
 "campaigns": 0,
 "acquisitionsByConversionDate": 0,
 "acquisitionsByReferralDate": 0,
 "creatives": 0,
 "Audiences": 0,
 "campaignName": "string"
}

GET Récapitulatif du Compte

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser à la place le Query API.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour l'activité totale d'un compte pour une période donnée, un fuseau horaire et une devise. Ce point de terminaison API peut être utilisé à la fois pour les données de compte partenaire Rokt Ecommerce et les données de compte annonceur Rokt Ads.

Description

Appelez ce point de terminaison API pour recevoir les métriques de performance au niveau du compte pour une période, un fuseau horaire et une devise spécifiés.

Requête

Chemin

GET /reporting/accounts/{accountId}/summary

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de date/heure demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de date/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true

Réponse

200 OK

{
  "campaignsSummary": {
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
  },
  "transactionsSummary": {
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "rpt": 0,
  "rpm": 0,
  "positivePlacementEngagements": 0,
  "purchases": 0
  }
}

GET Aperçu des Transactions du Compte

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour un compte partenaire Rokt Ecommerce sur une période de temps donnée, un fuseau horaire et une devise.

Description

Appelez ce point de terminaison (endpoint) API pour recevoir des métriques de transaction au niveau du compte, telles que les impressions de placement, les références et les revenus pour une période de temps spécifiée, un fuseau horaire et une devise.

Requête

Chemin

GET /reporting/accounts/{accountId}/transactions/overview

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de date/heure demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de date/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé via ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true

Réponse

200 OK

{
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "rpt": 0,
  "rpm": 0,
  "positivePlacementEngagements": 0,
  "purchases": 0
}

GET Répartition des Transactions du Compte

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour un compte partenaire Rokt Ecommerce ventilées par un attribut pour une période de temps donnée, un fuseau horaire et une devise.

Description

Appelez ce point de terminaison API pour recevoir des métriques de transaction au niveau du compte ventilées par un attribut spécifié dans la chaîne de requête pour une période de temps, un fuseau horaire et une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :

âge
sexe
page
type de page
emplacement
position

remarque

La ventilation par emplacement ne retourne pas de résultats pour les métriques au niveau de la page, y compris les transactions, les achats ou le RPT.

Requête

Chemin

GET /reporting/accounts/{accountId}/transactions/breakdown

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de date/heure demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de date/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true

Réponse

200 OK

{
  "groupByValue": "string",
  "revenue": 0,
  "transactions": 0,
  "placementImpressions": 0,
  "impressions": 0,
  "referrals": 0,
  "purchases": 0,
  "positivePlacementEngagements": 0,
  "rpt": 0,
  "rpm": 0
}

GET Audience Metadata

Description

Appelez ce point de terminaison API pour recevoir les métadonnées d'audience, telles que le nom de l'audience, la tranche d'âge, le genre et l'appareil.

Requête

Chemin

GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}

Paramètres

Nom	Type	Dans	Requis
`accountId`	String	path	true
`campaignId`	String	path	true
`audienceId`	String	path	true

Réponse

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "audienceId": "string",
  "name": "string",
  "ageRange": {
    "min": 0,
    "max": 0
  },
  "device": {
    "desktop": true,
    "tablet": true,
    "mobile": true
  },
  "gender": "string"
}

GET Campaign Overview

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser à la place le Query API.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour une campagne pour une période, un fuseau horaire et une devise spécifiés.

Description

Appelez cet endpoint API pour recevoir des métriques de performance au niveau de la campagne, telles que les impressions, les références et les conversions pour une période, un fuseau horaire et une devise spécifiés.

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de dates/temps demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de dates/temps demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true
`campaignId`	String	path		true

Réponse

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
}

GET Répartition de la campagne

remarque

⚠️ Avis de dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour une campagne réparties par pays, campagne, audience ou création pour une période, un fuseau horaire ou une devise spécifiés.

Description

Appelez cet endpoint API pour recevoir des données au niveau de la campagne réparties par un attribut spécifié dans la chaîne de requête pour une période, un fuseau horaire ou une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" incluent :

pays ;
campagne ;
audience ;
création ; ou
sous-verticale.

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de date/heure demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de date/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true
`campaignId`	String	path		true

Réponse

200 OK

{
 "groupByValue": "string",
 "grossCost": 0,
 "netCost": 0,
 "impressions": 0,
 "referrals": 0,
 "acquisitionsByConversionDate": 0,
 "acquisitionsByReferralDate": 0,
 "campaigns": 0,
 "creatives": 0,
 "audiences": 0,
 "campaignCountries": 0,
 "creativeName": "string"
}

GET Histogramme de Campagne

remarque

⚠️ Avis de Dépréciation

Cette API est dépréciée et ne sera plus mise à jour. Veuillez utiliser à la place l'API de requête.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour une campagne pour une période donnée, un fuseau horaire et une devise, ventilées par période.

Description

Appelez cet endpoint API pour recevoir un histogramme des métriques de performance d'une campagne, telles que les impressions, les références ou les conversions pour une période, un fuseau horaire et une devise spécifiés.

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de dates/temps demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de dates/temps demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé via ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true
`campaignId`	String	path		true

Réponse

200 OK

{
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
  },
 {
  "intervalTimestamp": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "campaigns": 0,
  "creatives": 0,
  "audiences": 0,
  "campaignCountries": 0
 }

GET Métadonnées de la campagne

Description

Appelez ce point de terminaison (endpoint) API pour recevoir les métadonnées d'une campagne spécifique.

Requête

Chemin

GET /metadata/accounts/{accountId}/campaigns/{campaignId}

Paramètres

Nom	Type	Dans	Requis
`accountId`	String	path	true
`campaignId`	String	path	true

Réponse

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "campaignName": "string",
  "campaignType": "string",
  "campaignObjective": "string",
  "countryCode": "string",
  "status": "string"
}

GET Vue d'ensemble de la Création

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Retourne les métriques de performance pour une création donnée pour une période, un fuseau horaire et une devise spécifiés.

Description

Appelez cet endpoint API pour obtenir des métriques de performance au niveau de la création, telles que les impressions, les références et les conversions pour une période, un fuseau horaire et une devise spécifiés.

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
dateStart	String	query	Heure de début de la plage de date/heure demandée	true	dateStart=2020-03-01T00:00:00.000
dateEnd	String	query	Heure de fin de la plage de date/heure demandée	true	dateEnd=2020-03-31T23:59:59.000
currency	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
timeZoneVariation	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé via ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
accountId	String	path		true
campaignId	String	path		true
creativeId	String	path		true

Réponse

200 OK

{
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "referrals": 0,
  "uniqueReferrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

GET Répartition des Créations

remarque

⚠️ Avis de Dépréciation

Cette API est obsolète et ne sera plus mise à jour. Veuillez utiliser l'API de requête à la place.

Consultez le Guide de Migration pour des exemples de requêtes équivalentes.

Renvoie les métriques de performance pour une création (creative) ventilées par un attribut pour une période, un fuseau horaire et une devise spécifiés.

Description

Appelez ce point de terminaison API pour obtenir des détails sur une création spécifique ventilée par un attribut spécifié dans la chaîne de requête pour une période, un fuseau horaire et une devise spécifiés. Les attributs qui peuvent être appelés via le paramètre "groupby" sont :

audience ;

Requête

Chemin

GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown

Paramètres

Nom	Type	Dans	Description	Requis	Exemple
`dateStart`	String	query	Heure de début de la plage de dates/temps demandée	true	dateStart=2020-03-01T00:00:00.000
`dateEnd`	String	query	Heure de fin de la plage de dates/temps demandée	true	dateEnd=2020-03-31T23:59:59.000
`currency`	Enum: AUD CAD EUR GBP JPY NZD SGD USD KRW CNY	query	Code de devise dans lequel vous recevrez les métriques monétaires.	true	currency=USD
`timeZoneVariation`	Enum: America/Chicago Pacific/Honolulu Australia/Sydney	query	Le fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.	true	timeZoneVariation=Australia/Sydney
`accountId`	String	path		true
`campaignId`	String	path		true
`creativeId`	String	path		true

Réponse

200 OK

{
  "groupByValue": "string",
  "grossCost": 0,
  "netCost": 0,
  "impressions": 0,
  "uniqueReferrals": 0,
  "referrals": 0,
  "acquisitionsByConversionDate": 0,
  "acquisitionsByReferralDate": 0,
  "creatives": 0,
  "audiences": 0
}

GET Métadonnées Créatives

Description

Appelez cet endpoint (point de terminaison) API pour recevoir les métadonnées créatives, y compris le nom créatif, le titre, le sous-titre, le texte, les réponses et le statut.

Requête

Chemin

GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}

Paramètres

Nom	Type	Dans	Requis
`accountId`	String	path	true
`campaignId`	String	path	true
`creativeId`	String	path	true

Réponse

200 OK

{
  "accountId": "string",
  "campaignId": "string",
  "creativeId": "string",
  "name": "string",
  "title": "string",
  "subtitle": "string",
  "text": "string",
  "responses": [
    "string"
  ],
  "status": "string"
}

Guide de Migration de l'API Query

Les clients passant à l'API Query peuvent se référer aux exemples ci-dessous pour reproduire le comportement de nos points de terminaison de reporting hérités.

Pour chaque exemple :

Remplacez :accountID, :campaignID ou :creativeID par les valeurs appropriées.

Ajustez startDate, endDate, currency et timezoneVariation selon vos besoins.

Utilisez le point de terminaison /help pour les définitions des métriques et dimensions disponibles.

Répartition de la Campagne du Compte

Hérité : GET /reporting/accounts/{accountId}/campaigns/breakdown
Remplacement API Query :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": [
      "impressions", "referrals", "gross_cost", "click_thru_acquisitions",
      "click_thru_acquisitions_by_conversion_time", "unique_creatives",
      "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"
    ],
    "dimensions": ["campaign_id", "campaign_name"]
}

Résumé du Compte - Annonceurs

Hérité : GET /reporting/accounts/{accountId}/summary
Remplacement API Query :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": []
}

Résumé du Compte - Partenaires

Hérité : GET /reporting/accounts/{accountId}/summary
Remplacement API Query :

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions

{
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "currency": "USD",
    "dimensionFilters": {},
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"],
    "dimensions": []
}

Aperçu des Transactions de Compte

Ancien : GET /reporting/accounts/{accountId}/transactions/overview
Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"]
}

Détail des Transactions

Ancien : GET /reporting/accounts/{accountId}/transactions/breakdown
Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/transactions

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["revenue", "transactions", "placement_impressions", "impressions", "referrals", "purchases", "positive_placement_engagements", "rpt", "rpm"],
    "dimensions": ["partner_id", "age_range", "gender", "page_type"]
}

Aperçu de la Campagne

Ancien : GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    }
}

Détail de la Campagne

Ancien : GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown
Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name", "audience_id", "campaign_country", "partner_sub_vertical"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    }
}

Histogramme de Campagne

Ancien : GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"]
    },
    "interval": "day"
}

Aperçu Créatif

Ancien : GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId} Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"],
        "creative_id": [":creativeID"]
    }
}

Détail Créatif

Ancien : GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown Remplacement de l'API de requête :

POST https://api.rokt.com/v1/query/accounts/:accountID/campaigns

{
    "currency": "USD",
    "timezoneVariation": "UTC",
    "startDate": "2025-03-04",
    "endDate": "2025-03-06",
    "metrics": ["impressions", "referrals", "gross_cost", "click_thru_acquisitions", "click_thru_acquisitions_by_conversion_time", "unique_creatives", "unique_campaigns", "unique_audiences", "unique_campaign_countries", "net_cost"],
    "dimensions": ["campaign_id", "campaign_name", "creative_id", "creative_name", "audience_id", "campaign_country", "partner_sub_vertical"],
    "dimensionFilters": {
        "campaign_id": [":campaignID"],
        "creative_id": [":creativeID"]
    }
}

Points de terminaison actuellement non pris en charge

Les points de terminaison suivants ne sont pas encore pris en charge par l'API de requête. Continuez à les utiliser jusqu'à nouvel ordre :

GET /metadata/accounts/{accountId}/campaigns/{campaignId}
➤ Métadonnées de la campagne
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
➤ Métadonnées de l'audience
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
➤ Métadonnées de la création

Avis de Dépréciation​

Pourquoi ce changement ?​

Support de Migration​

Aperçu​

Version​

Authentification​

Génération de l'ID d'application et du secret d'application​

Obtention d'un jeton d'accès​

Paramètres de requête dans l'en-tête​

Paramètres de requête dans le corps​

Exemple de requête réussie​

Points de terminaison de l'API​

Appeler un point de terminaison de l'API​

GET Account Campaigns Breakdown​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Récapitulatif du Compte​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Aperçu des Transactions du Compte​

Description​

Requête​

Chemin​

Réponse​

GET Répartition des Transactions du Compte​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Audience Metadata​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Campaign Overview​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Répartition de la campagne​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Histogramme de Campagne​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Métadonnées de la campagne​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Vue d'ensemble de la Création​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Répartition des Créations​

Description​

Requête​

Chemin​

Paramètres​

Réponse​

GET Métadonnées Créatives​

Description​

Avis de Dépréciation

Pourquoi ce changement ?

Support de Migration

Aperçu

Version

Authentification

Génération de l'ID d'application et du secret d'application

Obtention d'un jeton d'accès

Paramètres de requête dans l'en-tête

Paramètres de requête dans le corps

Exemple de requête réussie

Points de terminaison de l'API

Appeler un point de terminaison de l'API

GET Account Campaigns Breakdown

Description

Requête

Chemin

Paramètres

Réponse

GET Récapitulatif du Compte

Description

Requête

Chemin

Paramètres

Réponse

GET Aperçu des Transactions du Compte

Description

Requête

Chemin

Réponse

GET Répartition des Transactions du Compte

Description

Requête

Chemin

Paramètres

Réponse

GET Audience Metadata

Description

Requête

Chemin

Paramètres

Réponse

GET Campaign Overview

Description

Requête

Chemin

Paramètres

Réponse

GET Répartition de la campagne

Description

Requête

Chemin

Paramètres

Réponse

GET Histogramme de Campagne

Description

Requête

Chemin

Paramètres

Réponse

GET Métadonnées de la campagne

Description

Requête

Chemin

Paramètres

Réponse

GET Vue d'ensemble de la Création

Description

Requête

Chemin

Paramètres

Réponse

GET Répartition des Créations

Description

Requête

Chemin

Paramètres

Réponse

GET Métadonnées Créatives

Description