Pulling reports using Pull API

Paramètres de l'API (obligatoires)

api_token

Clé d'autorisation de l'API externe de l'utilisateur : « {Account owner API Key should be used} »

from

Date de début du rapport au format « yyyy-mm-dd » ou « yyyy-mm-dd hh:mm ». Par exemple : 2010-01-01 ou 2010-01-01%2000%3A15 - (le paramètre des heures concerne uniquement les rapports de données brutes).

to

Date de fin du rapport. Format identique à from

Paramètres de filtrage de l'API (facultatifs)

Filtrer par source média

Le filtrage des rapports permettant d'afficher uniquement une source média donnée est disponible en ajoutant les paramètres de la catégorie et de la source média à l'URL de la requête :

category

Permet d'obtenir l'ensemble de données Facebook category=facebook dans l'URL. Permet d'obtenir l'ensemble des données Twitter category=twitter dans l'URL. Pour les autres ensembles de données de source média, utilisez category=standard

media_source

Spécifiez le nom d'une seule source média (media_source=[SOURCE_NAME]) telle qu'indiquée sur le tableau de bord d'AppsFlyer.

https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=standard&media_source=googleadwords_int

https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=facebook&media_source=facebook

Filtrer par nom d'évènement

Le filtrage des données brutes du rapport des évènements in-app permet d'inclure uniquement un évènement particulier en utilisant le paramètre event_name. Pour filtrer plusieurs évènements, utilisez une liste d'évènements séparée par des virgules.

Par exemple : event_name=af_purchase,ftd

Pour les exports de retargeting

Utilisez reattr=true pour obtenir les résultats attribués aux campagnes de retargeting.

Champs supplémentaires

L'API Pull vous permet d'ajouter certains champs venant compléter dans certains cas le tableau des installations de données brutes et des évènements in-app.

Pour ajouter de nouveaux champs, ajoutez « &additional_fields= » au lien de suivi, suivi par la liste des champs supplémentaires séparée par des virgules. Voir ci-dessous les exemples d'API Pull.

Vous obtenez un rapport CSV comprenant des colonnes supplémentaires contenant des informations, le cas échéant.

Fuseau horaire et devise

timezone (facultatif)

Vous pouvez obtenir les données brutes de l'API Pull dans N'IMPORTE QUEL fuseau horaire valide :

1. Ajoutez &timezone=[Joda-Time] dans le lien d'API Pull pour obtenir le rapport selon le fuseau horaire favori (voir remarque ci-dessous)
2. Ajoutez &timezone=[Numerical value] dans le lien d'API Pull pour obtenir le rapport selon le fuseau horaire numérique spécifié. Par exemple : pour le fuseau horaire UTC+10:00, ajoutez le lien & timezone=%2B10:00
   L'utilisation de la valeur numérique pour le fuseau horaire n'est possible que lors de l'extraction de rapports de données brutes. Cela ne fonctionne pas avec les rapports agrégés tels que les rapports de performance.
3. Dans le cas contraire, les données sont obtenues selon le fuseau horaire UTC par défaut.

currency (facultatif)

Permet d'obtenir les données de revenu et de coût dans la devise sélectionnée, et non en USD (option par défaut). Ce paramètre est défini par l'administrateur du compte.

Pour obtenir les données dans la devise favorite, ajoutez &currency=preferred au lien de requête

permet d'obtenir les données de revenu et de coût dans la devise sélectionnée.

Politique de l'API et limitations d'utilisation

La politique de l'API AppsFlyer permet de garantir aux utilisateurs un excellent niveau de service de l'API Pull en limitant le nombre total de requêtes quotidiennes et en évitant l'utilisation incorrecte du service.

Voir les détails concernant la politique de l'API relative aux données agrégées et aux données brutes via l'API Pull.

Le nombre maximum d'entrées par rapport est de 200K. Si vous obtenez un rapport comprenant 200K lignes, certains des résultats ont été ignorés.

Sécurité de l'API

Tous les liens de l'API Pull emploient des connexions https chiffrées.

Exemples de liens d'API Pull

Vous pouvez obtenir le code API exact, y compris le jeton API, dans AppsFlyer. Allez à Intégration > Accès API.

Version de l'API (V5)

• Inchangé :

  • L'API existante (v4) peut encore être utilisée

  • La version n'applique aucune modification au format de fichier ou aux en-têtes

Les rapports (de performances) agrégés fournissent des détails concernant l'efficacité des campagnes publicitaires.  Ces rapports peuvent être basés sur des données LTV ou d'activité. Vérifiez donc les spécifications du rapport.

Paramètres de l'API (obligatoires)

api_token

Clé d'autorisation de l'API externe de l'utilisateur : « {Account owner API Key should be used} ». Le jeton d'API est fourni UNIQUEMENT au propriétaire du compte

Paramètres de filtrage de l'API (facultatifs)

Filtrer par source média

Le filtrage des rapports permettant d'afficher uniquement une source média donnée est disponible en ajoutant les paramètres de la catégorie et de la source média à l'URL de la requête :

category

Permet d'obtenir l'ensemble de données Facebook category=facebook dans l'URL. Pour les autres ensembles de données de source média, utilisez category=standard

media_source

Spécifiez le nom d'une seule source média (media_source=[SOURCE_NAME]) telle qu'indiquée sur le tableau de bord d'AppsFlyer.

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=standard&media_source=googleadwords_int

https://hq.appsflyer.com/export/com.greatapp/partners_report/v5?api_token=xxxx
&from=2018-04-09&to=2018-05-09&category=facebook&media_source=facebook

Fuseau horaire et devise

timezone (facultatif)

Vous pouvez obtenir les données agrégées via l'API Pull à l'heure UTC ou au fuseau horaire favori de l'app, défini à la page Param`ètres de l'App :

1. Ajoutez &timezone=[selected Joda-Time] dans le lien de l'API Pull pour obtenir le rapport selon le fuseau horaire favori de l'app (voir remarque ci-dessous)

2. Dans le cas contraire, les données sont obtenues selon le fuseau horaire UTC par défaut.

currency (facultatif)

Permet d'obtenir les données de revenu et de coût dans la devise sélectionnée, et non en USD (option par défaut). Ce paramètre est défini par l'administrateur du compte.

currency=preferred

permet d'obtenir les données de revenu et de coût dans la devise sélectionnée.

Politique de l'API

La politique de l'API AppsFlyer permet de garantir aux utilisateurs un excellent niveau de service de l'API Pull en limitant le nombre total de requêtes quotidiennes et en évitant l'utilisation incorrecte du service.

Le nombre maximum d'entrées par rapport est de 200K. Si vous obtenez un rapport comprenant 200K lignes, certains des résultats ont été ignorés.

Sécurité de l'API

Tous les liens de l'API Pull emploient des connexions https chiffrées.

Pour plus de détails, allez ici.

Exemples de liens d'API Pull

Version de l'API (V5)

• Modifications :

  • Dans la version (v5), les rapports de performances contenant plusieurs partenaires regroupent les données Facebook par campagne uniquement. Les rapports de performances contenant uniquement des données Facebook (en spécifiant &category=facebook) regroupent les données par campagne et par groupe de publicité.

  • La page Exporter des données des rapports agrégés utilise la version d'API (v5)

• Inchangé :

  • L'API existante (v4) peut encore être utilisée

  • La version n'applique aucune modification au format de fichier ou aux en-têtes

Les données agrégées Protect360 figurent dans le tableau de détection avancée du tableau de bord.

Paramètres de l'API (obligatoires)

api_token

Clé d'autorisation de l'API externe de l'utilisateur : « {Account owner API Key should be used} »

from

Date de début du rapport au format « yyyy-mm-dd » ou « yyyy-mm-dd hh:mm ». Par exemple : 2010-01-01 ou 2010-01-01%2000%3A15 - (le paramètre des heures concerne uniquement les rapports de données brutes).

to

Date de fin du rapport. Format identique à from

KPI (requis)

Les paramètres Protect360 sont les mêmes dans l'API Pull et l'API principale. 

Pour la liste des KPI disponibles et leurs descriptions, cliquez ici.

Paramètres de filtrage de l'API (facultatifs)

Filtrer par source média

Le filtrage des rapports permettant d'afficher uniquement une source média donnée peut être effectué en ajoutant :
pid=media source name.

Fuseau horaire et devise

timezone (facultatif)

Vous pouvez obtenir les données agrégées P360 via l'API Pull à l'heure UTC ou au fuseau horaire favori de l'app, défini à la page Param`ètres de l'app :

1. Ajoutez &timezone=preferred dans le lien de l'API Pull pour obtenir le rapport selon le fuseau horaire favori de l'app

2. Dans le cas contraire, les données sont obtenues selon le fuseau horaire UTC par défaut.

currency (facultatif)

Permet d'obtenir les données de revenu et de coût dans la devise sélectionnée, et non en USD (option par défaut). Ce paramètre est défini par l'administrateur du compte.

currency=preferred

permet d'obtenir les données de revenu et de coût dans la devise sélectionnée.

Sécurité de l'API

Tous les liens de l'API Pull emploient des connexions https chiffrées.

Exemples de liens d'API Pull

Remarque : pour voir tous les liens API Pull : dans AppsFlyer, allez à Intégration > Accès API.

Version de l'API (V5)

• Modifications :

  • Dans la version (v5), les rapports de performances contenant plusieurs partenaires regroupent les données Facebook par campagne uniquement. Les rapports de performances contenant uniquement des données Facebook (en spécifiant &category=facebook) regroupent les données par campagne et par groupe de publicité.

  • La page Exporter des données des rapports agrégés utilise la version d'API (v5)

• Inchangé :

  • L'API existante (v4) peut encore être utilisée

  • La version n'applique aucune modification au format de fichier ou aux en-têtes

Scripts permettant de récupérer les données de l'API Pull

Il est souvent plus pratique de mettre en place des scripts automatisés pour récupérer périodiquement des données.

Vous trouverez ci-dessous des scripts permettant de récupérer des données à partir de l'API Pull. Les exemples de scripts rassemblent les données du rapport d'installation. Modifiez les scripts selon vos besoins en termes de contenu du rapport et des données à récupérer.

import okhttp3.*;

import java.io.BufferedWriter;
import java.io.FileWriter;

import java.util.concurrent.TimeUnit;

public class PullApi {
  public static void main(String[] args){

    String appID = "<APP_ID>";
    String reportType = "<REPORT_TYPE>";
    String apiToken = "<API_TOKEN>";
    String from = "<FROM_DATE>";
    String to = "<TO_DATE>";
    String requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;

    OkHttpClient client = new OkHttpClient.Builder()
        .connectTimeout(30, TimeUnit.SECONDS)
        .readTimeout(30, TimeUnit.SECONDS)

        .build();

    Request request = new Request.Builder()
        .url(requestUrl)
        .addHeader("Accept", "text/csv")
        .build();

    try {
      Response response = client.newCall(request).execute();

      if(response.code() != 200) {
        if(response.code() == 404) {
          System.out.println("There is a problem with the request URL. Please make sure it is correct");
        }
        else {
          assert response.body() != null;
          System.out.println("There was a problem retrieving the data: " + response.body().string());
        }
      } else {
        assert response.body() != null;
        String data = response.body().string();
        BufferedWriter writer;

        writer = new BufferedWriter(new FileWriter(appID + "-" + reportType + "-" + from + "-to-" + to + ".csv"));
        writer.write("");
        writer.write(data);
        writer.close();
      }
      System.exit(0);
    } catch (Exception e) {
      e.printStackTrace();
      System.exit(1);
    }
  }
}

request = require('request');
const fs = require('fs');

const appID = '<APP_ID>';
const reportType = '<REPORT_TYPE>';
const apiToken = '<API_TOKEN>';
const from = '<FROM_DATA>';
const to = '<T0_DATE>';
const requestUrl = `https://hq.appsflyer.com/export/${appID}/${reportType}/v5?api_token=${apiToken}&from=${from}&to=${to}`;

request(requestUrl, (error, response, body) => {
  if (error) {
    console.log('There was a problem retrieving data:', error);
  }
  else if (response.statusCode != 200) {
    if (response.statusCode === 404) {
      console.log('There is a problem with the request URL. Make sure that it is correct');
    } else {
      console.log('There was a problem retrieving data:', response.body);
    }
  } else {
    fs.writeFile(`${appID}-${reportType}-${from}-to-${to}.csv`, response.body, (err) => {
      if (err) {
        console.log('There was a problem writing to file: ', err);
      } else {
        console.log('File was saved');
      }
    });
  }
  
});

import requests

app_id = '<APP_ID>'
report_type = '<REPORT_TYPE>'

params = {
  'api_token': '<API_TOKEN>',
  'from': 'FROM_DATE',
  'to': 'TO_DATE'
}

request_url = 'https://hq.appsflyer.com/export/{}/{}/v5'.format(app_id, report_type)

res = requests.request('GET', request_url, params=params)

if res.status_code != 200:
  if res.status_code == 404:
    print('There is a problem with the request URL. Make sure that it is correct')
  else:
    print('There was a problem retrieving data: ', res.text)
else:
  f = open('{}-{}-{}-to-{}.csv'.format(app_id, report_type, params['from'], params['to']), 'w', newline='', encoding="utf-8")
  f.write(res.text)
  f.close()

using System;
using RestSharp;
using System.Text;
using System.Net;
using System.IO;
namespace Pull_API
{
  class PullAPi
  {
    static void Main(string[] args)
    {
      var appID = "<APP_ID>";
      var reportType = "<REPORT_TYPE>";
      var apiToken = "<API_TOKEN>";
      var from = "<FROM_DATE>";
      var to = "<TO_DATE>";

      var requestUrl = "https://hq.appsflyer.com/export/" + appID + "/" + reportType + "/v5?api_token=" + apiToken + "&from=" + from + "&to=" + to;
      
      var client = new RestClient(requestUrl);
      var request = new RestRequest(Method.GET);
      request.AddHeader("Accept", "text/csv; charset=UTF-8");

      IRestResponse response = client.Execute(request);
      HttpStatusCode statusCode = response.StatusCode;
      int numericStatusCode = (int)statusCode;

      if(numericStatusCode != 200){

        if(numericStatusCode == 404){
          Console.WriteLine("There is a problem with the request URL. Make sure that it is correct.");
        } else {
          Console.WriteLine("There was a problem retrieving data: " + response.Content); 
        }
      } else {
        System.IO.File.WriteAllText(@"" + appID + "-" + reportType + "-" + from + "-to-" + to + ".csv", response.Content);
        Console.WriteLine("Data retrieved succesfully"); 
      }
    }
  }
}

<?

$appID = '<APP_ID>';
$reportType = '<REPORT_TYPE>';
$apiToken = '<API_TOKEN>';
$from = '<FROM_DATE>';
$to = '<TO_DATE>';
$query = http_build_query([
'api_token' => $apiToken,
'from' => $from,
'to' => $to
]);
$requestUrl = 'https://hq.appsflyer.com/export/' . $appID . '/' . $reportType . '/v5?'.$query;
$report = $appID . '-' . $report . '-' . $from . '-to-' . $to; 

$curl = curl_init($requestUrl);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_ENCODING, "");
curl_setopt($curl, CURLOPT_NOSIGNAL, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_MAXREDIRS, 10);
curl_setopt($curl, CURLOPT_FAILONERROR, true);
curl_setopt($curl, CURLOPT_TIMEOUT, 100);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
 "cache-control: no-cache",
 "Accept: text/csv; charset=UTF-8"
));


$response = curl_exec($curl);
$info = curl_getinfo($curl);
$err = curl_error($curl);
curl_close($curl);

var_dump($response);
if ($err) {
 echo $info['http_code']; 
 echo "cURL Error #: " . $err . '. ';
 if ($info['http_code'] == 404) {
  echo 'There is a problem with the request URL. Make sure that it is correct';
 } 
 if ($info['http_code'] == 401) {
  echo 'There was a problem retrieving data: authentication failed.';
 }
 
 echo PHP_EOL;

} else {
 $fp = fopen($report, 'w+');
 fwrite($fp, $response);
 fclose($fp);
 echo $response;
}
?>

Erreurs API et dépannage

Cette section aborde les erreurs courantes de l'API ainsi que leur résolution.