Aller au contenu principal

API de Reporting

remarque

Avis de DépréciationLien direct vers Avis de Dépréciation

Les API de Reporting Rokt documentées ci-dessous sont désormais dépréciées 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 ?Lien direct vers Pourquoi ce changement ?

L'API de Requête fournit une interface modernisée et unifiée pour récupérer les données de campagne et de transaction, 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 MigrationLien direct vers 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 mappe 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 supportés

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

Vue d'ensembleLien direct vers Vue d'ensemble

L'API de Reporting Rokt permet aux annonceurs et 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 commerciales externes. L'API fonctionne avec n'importe quel langage supportant les requêtes HTTP. Presque toutes les requêtes sont transmises à 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 et un Secret d'application pour obtenir un jeton d'accès. Les requêtes API sans authentification échoueront. L'API de Reporting Rokt ne vous permet de récupérer des données que des comptes auxquels vos identifiants utilisateur ont accès.

VersionLien direct vers Version

Pour les premiers utilisateurs utilisant la version Alpha de l'API, assurez-vous que "rokt-version":"alpha-20200701" est utilisé dans l'en-tête de votre requête API pour minimiser les changements potentiellement perturbateurs. 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.

AuthentificationLien direct vers Authentification

L'API de Reporting Rokt utilise l'approche OAuth 2.0 pour l'intégration client. Consultez le Flux d'Informations d'Identifiants OAuth 2.0 pour plus de détails. Vous devez utiliser votre ID d'application Rokt et votre Secret d'application pour accéder à l'API de Reporting Rokt.

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'applicationLien direct vers Génération de l'ID d'application et du Secret d'application

  1. Connectez-vous à One Platform sur my.rokt.com.

  2. Naviguez vers Paramètres du Profil sous l'icône de votre compte en bas à gauche.

    img

  3. Faites défiler jusqu'à la section Générer des Informations d'Identifiants API Personnels.

  4. Entrez le nom de votre application.

  5. Cliquez sur Générer.

  6. Vos informations d'identification pour l'API de Reporting et l'API d'Événements seront générées immédiatement et ressembleront à ceci :

    AppId: "40svbin0d194subpohl079rhck"
    AppSecret: "1dimhvr1v6skae9uhvtgs3chs2astnjf0469df6ul9hurubtoovn"

  7. 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.

  8. Vous pouvez utiliser ces informations d'identification immédiatement.

Vous devez garder les informations d'identification confidentielles afin de protéger votre compte et elles ne doivent jamais être envoyées 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èsLien direct vers 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 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 accès.

L'authentification à l'API est effectuée via OAuth 2.0. Pour exécuter un appel API réussi, vous devrez utiliser un ID d'application et un Secret d'application pour obtenir un jeton d'accès qui devra être utilisé dans tous les appels API. L'ID d'application et le Secret d'application 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 Rokt, vous ne pouvez récupérer des données que des comptes auxquels vos informations d'identification utilisateur ont accès.

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

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

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

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

CléDansDescriptionRequis?Exemple
Authorizationheaderapp_id et app_secret doivent être passés dans l'en-tête d'autorisation via l'autorisation HTTP Basic et peuvent être générés sous Paramètres de profil dans One Platform ; le contenu de l'en-tête est Basic base64encode(app_id:app_secret)OuiBasic base64encocde(12345:abcde)
Content-TypeheaderLe type de média de la requête doit toujours être application/x-www-form-urlencodedOuiapplication/x-www-form-urlencoded

Paramètres de requête dans le corpsLien direct vers Paramètres de requête dans le corps

CléDansDescriptionRequis?Exemple
grant_typebodyDoit être client_credentialsOuiclient_credentials

Exemple de requête réussieLien direct vers 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'APILien direct vers Points de terminaison de l'API

Appeler un point de terminaison de l'APILien direct vers 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 des points de terminaison sur l'API de rapport 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"

OBTENIR la Répartition des Campagnes de CompteLien direct vers OBTENIR la Répartition des Campagnes de 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 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.

DescriptionLien direct vers 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 :

  • pays

RequêteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/breakdown
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétairestruecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être au format OlsontruetimeZoneVariation=Australia/Sydney
accountIdStringpathVotre ID de compte Rokt. Trouvé dans One Platform ou fourni par votre gestionnaire de compte. true 

RéponseLien direct vers 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ésumé du CompteLien direct vers GET Résumé 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 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é pour les données de compte partenaire Rokt Ecommerce et les données de compte annonceur Rokt Ads.

DescriptionLien direct vers 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/summary
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de l'intervalle de date/heure demandétruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de l'intervalle de date/heure demandétruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

RéponseLien direct vers 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 CompteLien direct vers 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 à 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 un compte partenaire Rokt Ecommerce sur une période donnée, un fuseau horaire et une devise.

DescriptionLien direct vers Description

Appelez ce point de terminaison 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, un fuseau horaire et une devise spécifiés.

RequêteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/transactions/overview

Paramètres

NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé via ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

RéponseLien direct vers 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 CompteLien direct vers GET Répartition des Transactions du Compte

remarque

⚠️ Avis de Dépréciation

Cette API est dépréciée 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 équivalents.

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

DescriptionLien direct vers Description

Appelez ce point de terminaison API pour recevoir les métriques de transaction au niveau du compte réparties 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" incluent :

  • âge
  • sexe
  • page
  • type de page
  • emplacement
  • position
remarque

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

RequêteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/transactions/breakdown
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 

RéponseLien direct vers 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 MetadataLien direct vers GET Audience Metadata

DescriptionLien direct vers Description

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

RequêteLien direct vers Requête

CheminLien direct vers Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
ParamètresLien direct vers Paramètres
NomTypeDansRequis
accountIdStringpathtrue
campaignIdStringpathtrue
audienceIdStringpathtrue

RéponseLien direct vers 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 OverviewLien direct vers GET Campaign Overview

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 d'une campagne pour une période, un fuseau horaire et une devise spécifiés.

DescriptionLien direct vers Description

Appelez ce point de terminaison API pour recevoir les 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

RéponseLien direct vers 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 CampagneLien direct vers GET Répartition de la Campagne

remarque

⚠️ Avis de Dépréciation

Cette API est dépréciée 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 équivalents.

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

DescriptionLien direct vers Description

Appelez ce point de terminaison API pour recevoir des données au niveau de la campagne ventilées par un attribut spécifié dans la chaîne de requête pour une période de temps, 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown?groupby=creative
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de dates/heures demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de dates/heures demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé via ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

RéponseLien direct vers 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 CampagneLien direct vers 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 d'une campagne pour une période donnée, un fuseau horaire et une devise, ventilées par période.

DescriptionLien direct vers Description

Appelez ce point de terminaison 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 

RéponseLien direct vers 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 CampagneLien direct vers GET Métadonnées de la Campagne

DescriptionLien direct vers Description

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

RequêteLien direct vers Requête

CheminLien direct vers Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}
ParamètresLien direct vers Paramètres
NomTypeDansRequis
accountIdStringpathtrue
campaignIdStringpathtrue

RéponseLien direct vers Réponse

200 OK

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

GET Aperçu CréatifLien direct vers GET Aperçu Créatif

remarque

⚠️ Avis de Dépréciation

Cette API est dépréciée 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 créatif pour une période donnée, un fuseau horaire et une devise.

DescriptionLien direct vers Description

Appelez ce point de terminaison API pour obtenir des métriques de performance au niveau créatif, 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/overview
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartStringqueryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndStringqueryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdStringpath true 
campaignIdStringpath true 
creativeIdStringpath true 

RéponseLien direct vers 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éationsLien direct vers 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 équivalents.

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

DescriptionLien direct vers 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown
ParamètresLien direct vers Paramètres
NomTypeDansDescriptionRequisExemple
dateStartChaînequeryHeure de début de la plage de date/heure demandéetruedateStart=2020-03-01T00:00:00.000
dateEndChaînequeryHeure de fin de la plage de date/heure demandéetruedateEnd=2020-03-31T23:59:59.000
currencyEnum:
AUD
CAD
EUR
GBP
JPY
NZD
SGD
USD
KRW
CNY		queryCode de devise dans lequel vous recevrez les métriques monétaires.truecurrency=USD
timeZoneVariationEnum:
America/Chicago
Pacific/Honolulu
Australia/Sydney		queryLe fuseau horaire souhaité peut être passé par ce paramètre. Il doit être au format Olson.truetimeZoneVariation=Australia/Sydney
accountIdChaînepath true 
campaignIdChaînepath true 
creativeIdChaînepath true 

RéponseLien direct vers 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éativesLien direct vers GET Métadonnées Créatives

DescriptionLien direct vers Description

Appelez ce 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êteLien direct vers Requête

CheminLien direct vers Chemin
GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
ParamètresLien direct vers Paramètres
NomTypeDansRequis
accountIdStringpathtrue
campaignIdStringpathtrue
creativeIdStringpathtrue

RéponseLien direct vers 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 de RequêteLien direct vers Guide de Migration de l'API de Requête

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

Pour chaque exemple :

  • Remplacez :accountID, :campaignID ou :creativeID par les valeurs appropriées.
  • Ajustez startDate, endDate, currency et timezoneVariation selon les besoins.
  • Utilisez le point de terminaison /help pour les définitions des métriques et dimensions disponibles.
Détail de la Campagne du Compte

Hérité : GET /reporting/accounts/{accountId}/campaigns/breakdown
Remplacement API de Requête :

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 de Requête :

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 de Requête :

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 du Compte

Hérité : GET /reporting/accounts/{accountId}/transactions/overview
Remplacement 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

Hérité : GET /reporting/accounts/{accountId}/transactions/breakdown
Remplacement 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

Héritage: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/overview
Remplacement 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

Héritage: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/breakdown
Remplacement 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 la Campagne

Héritage: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/histogram Remplacement 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

Héritage: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId} Remplacement 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

Héritage: GET /reporting/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}/breakdown Remplacement 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 chargeLien direct vers 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 campagne

  • GET /metadata/accounts/{accountId}/campaigns/{campaignId}/audiences/{audienceId}
    ➤ Métadonnées d'audience

  • GET /metadata/accounts/{accountId}/campaigns/{campaignId}/creatives/{creativeId}
    ➤ Métadonnées de création

Cet article vous a-t-il été utile ?
Last updated Aug 4, 2026