API de rapport 2.0 pour les éditeurs

Contenu

Présentation

L'API de rapport permet aux éditeurs d'accéder par programmation aux données présentes sur le tableau de bord. Votre clé d'API de rapport est identique pour toutes vos applications. Chaque application possède un ID d'API de rapport unique, que vous pouvez trouver sur sa page.

Hôte

Hôte : https://report.api.vungle.com/ext/pub/reports/performance

Authentification

La sécurité est gérée dans l'en-tête de demande. Trouvez votre clé d'API dans la page des rapports sur le tableau de bord. Si vous ne disposez pas déjà d'une clé d'API, envoyez un e-mail à l'adresse tech-support@vungle.com pour en demander une !

En-têtes de demande

Clé Valeur Description
Authorization: Bearer [API Key] Clé d'API
Vungle-Version: 1 Version d'API
Accept: text/csv or application/json Accepted data format for results. Default is text/csv.

 

Résultats

  • Format : nous prenons en charge les formats JSON et CSV.
  • Plage de date : des informations historiques sont disponibles pendant 6 mois. Pour récupérer d'anciennes données, envoyez un e-mail à votre gestionnaire de compte à l'adresse tech-support@vungle.com.
  • En cas d'absence de données: notez que si aucune données n'est disponible pour votre requête, Vungle renvoie 200 réponses vides. Cela indique que la demande a réussie, mais qu'il n'y a aucune donnée disponible à renvoyer.

Ressources : GET /reports/performance

Paramètres de filtre

Utilisez les paramètres de filtre pour restreindre les résultats à un sous-ensemble de vos données de performances. La plupart des filtres sont facultatifs, auquel cas Vungle renvoie tous les résultats pour ce filtre.

Nom du paramètre Format Action Si indisponible Exemple
start Date ISO8601 Limite l'ensemble de résultats aux données de performances à partir de cette date Rejette une demande start=2017-01-01
end Date ISO8601 Limite l'ensemble de résultats aux données de performances jusqu'à cette date Rejette une demande end=2017-01-02 
country  Liste séparée par des virgules de codes de pays ISO 3166-1 Alpha-2 Renvoie uniquement des données de performances correspondant aux pays répertoriés Renvoie tous les pays

country=US

country=US,CA

country=US,CA,AU
applicationId  Renvoie une liste séparée par des virgules d'ID d'application Vungle Renvoie uniquement des données de performances pour les applications répertoriées Renvoie toutes les applications

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 Renvoie uniquement des données de performances pour le trafic répondant ou non au mécanisme d'incitation Renvoie du trafic répondant et ne répondant pas au mécanisme d'incitation

incentivized=true

incentivized=false

Paramètre des dimensions

Utilisez les dimensions pour réaliser vos rapports plus ou mois granulaires. Envoyez les dimensions sous forme de liste séparée par des virgules sous un paramètre dimensions. Si vous ne demandez pas explicitement une dimension, Vungle ne décompose pas le rapport jusqu'à cette dimension.

Utilisation du paramètre des dimensions

Nom du paramètre Format Exemple
dimensions Liste séparée par des virgules de chaînes spécifiques, répertoriées dans le tableau ci-dessous

dimensions=platform

dimensions=application,date,country

 

Dimensions disponibles

Nom de la 
dimension
Renvoie Exemple de renvoi
platform Groupé par chaîne de plateforme
platform
iOS
application Groupé par ID et nom d'application Vungle
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
emplacement

Groupé par ID et nom d'emplacement.

Pour les applications qui continuent d'utiliser Vungle SDK v. 4.1 et les versions antérieures, qui ne prennent pas en charge les emplacements, id d'emplacement et nom d'emplacement afficheront une valeur nulle dans nos rapports, mais les agrégations tells que les vues et les recettes de l'éditeur seront toujours correctes. Ainsi, les appareils non mis à jour figureront toujours dans les rapports, mais sans les répartitions des emplacements, qui seront nulles.

placement id placement name
12345678 Level 3
date  Groupé par date 
date
2017-01-01
country Groupé par pays
country
US
incentivized Groupé par trafic répondant au mécanisme d'incitation
incentivized
true
false

Pour les dimensions exigeant une recherche de nom (par exemple, nom de l'application), si Vungle est incapable de récupérer la recherche, nous renvoyons une chaîne « Inconnu » à la place du nom.

Paramètre des agrégats

Utilisez les agrégats pour définir les données de performances qui vous intéressent. Envoyez les agrégats sous forme de liste séparée par des virgules sous un paramètre agrégats. Si un agrégat ne se trouve pas dans la liste, Vungle suppose que vous ne souhaitez pas recevoir cette donnée.

Utilisation du paramètre des agrégats

Nom du paramètre Format Exemple
aggregates Liste séparée par des virgules de chaînes spécifiques, répertoriées dans le tableau ci-dessous

aggregates=views

aggregates=views,installs,ecpm

 

Agrégats disponibles

Nom de la 
dimension
Renvoie
views integer
completes integer
clicks  integer 
revenue  integer
ecpm (recettes de l'éditeur * 1000 / vues) comme un nombre flottant

  

Exemples de questions et de réponses

Exemple 1 : recettes JSON

Demande


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Réponse


[
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "US",
        "views": 1234,
        "revenue": 123.0,
        "ecpm": 99.67,       
    },
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "CA",
        "view": 35,
        "revenue": 2.0,
        "ecpm": 57.14,
    },
    ...
]

Exemple 2 : recettes CSV

Demande


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Réponse


Platform,date,country,views,revenue
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0
...

Example 3: Placement

Demande

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET 
"https://report.api.vungle.com/ext/pub/reports/performance?dimensions=placement&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Réponse


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0       
    }
]
Vous avez d’autres questions ? Envoyer une demande

Commentaires