Pulling reports using Pull API

Parâmetros da API (obrigatório)

api_token

É a chave de autorização externa da API do usuário: "{Account owner API Key should be used}"

from (a partir de)

Data de início do relatório no formato "aaaa-mm-dd" ou "aaaa-mm-dd hh: mm". Por exemplo: 2010-01-01 ou 2010-01-01%2000%3A15 (o parâmetro de horas é para relatórios brutos apenas).

to (até)

Data final do relatório. Mesmo formato de from (a partir de)

Parâmetros de filtragem da API (opcional)

Filtrar por fonte de mídia

Está disponível o filtro de relatórios para listar apenas uma fonte de mídia específica adicionando tanto o parâmetro de categoria quanto a fonte de mídia à URL de solicitação:

category

Para obter dados do Facebook defina category=facebook na URL. Para obter dados do Twitter defina category=twitter na URL. Para qualquer outra fonte de mídia específica, defina category=standard

media_source

Forneça o nome de uma fonte de mídia única (media_source=[NOME_FONTE]) como aparece no painel da 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

Filtrar por nome do evento

Filtre os dados brutos do relatório de eventos in-app para incluir somente um evento específico, usando o parâmetro event_name. Para filtrar vários eventos, use uma lista de eventos separados por vírgula.

Por exemplo: event_name=af_purchase,ftd

Para exportações de redirecionamento

Use reattr=true para obter resultados atribuídos às campanhas de redirecionamento.

Campos adicionais

Por meio da API de pull, você pode adicionar alguns campos que completam o quadro para instalações de dados brutos e eventos in-app em alguns casos.

Para adicionar novos campos, adicione "&additional_fields=" ao link de atribuição, seguido pela lista separada por vírgulas de campos adicionais. Consulte os exemplos de Pull API abaixo.

O resultado é um relatório CSV com colunas adicionadas, que contêm informações, quando relevantes.

Fuso horário e moeda

timezone (opcional)

É possível obter os dados brutos da API de pull em QUALQUER fuso horário válido:

1. Adicione &timezone=[Joda-Time] no link da API de pull para receber o relatório no fuso horário preferido (veja a observação abaixo)
2. Adicione &timezone=[Valor numérico] ao link da Pull API para receber o relatório no fuso horário numérico especificado. Por exemplo: para o fuso horário UTC+10:00, adicione no link&timezone=%2B10:00
   Usar o valor numérico para fuso horário só é possível ao obter relatórios de dados brutos. Não funciona com relatórios agregados anuais, como relatórios de desempenho.
3. Caso contrário, os dados serão recebidos no fuso horário padrão UTC.

currency (opcional)

É usado para receber os dados de receita e custo na moeda selecionada, em vez de USD, que é a opção padrão. Isso é definido pelo administrador da conta.

Para receber os dados em sua moeda preferida, adicione o seguinte ao seu link de solicitação: & currency=preferencial

é usado para receber dados de receitas e custos na moeda selecionada.

Política de API e limitações de uso

A Política de API da AppsFlyer garante alta qualidade de serviço para os usuários da API de pull, limitando o número total de solicitações diárias e impedindo o abuso do serviço.

Consulte os detalhes sobre a política de API para dados agregados por meio da API de pull e para dados brutos por meio da API de pull.

O número máximo de registros por relatório é 200.000. Se você receber um relatório com 200.000 linhas, então alguns resultados ficaram de fora.

Segurança da API

Todos os links da API de pull usam conexões https criptografadas e seguras.

Exemplos de links da API de pull

Você pode obter o código exato da API, incluindo o token da API na AppsFlyer. Acesse Integration > API Access (Integração > Acesso à API).

Versão da API (V5)

• Inalterado:

  • A API existente (v4) ainda está disponível para uso

  • A versão não aplica qualquer alteração ao formato de arquivo ou aos cabeçalhos

Os relatórios agregados (desempenho) fornecem detalhes da eficácia das campanhas publicitárias.  Esses relatórios podem ser baseados em atividade ou LTV, portanto, verifique a especificação do relatório.

Parâmetros da API (obrigatório)

api_token

É a chave de autorização externa da API do usuário: "{Account owner API Key should be used}" O token da API é exibido APENAS para o proprietário da conta

Parâmetros de filtragem da API (opcional)

Filtrar por fonte de mídia

Está disponível o filtro de relatórios para listar apenas uma fonte de mídia específica adicionando tanto o parâmetro de categoria quanto a fonte de mídia à URL de solicitação:

category

Para obter dados do Facebook defina category=facebook na URL. Para qualquer outra fonte de mídia específica, defina category=standard

media_source

Forneça o nome de uma fonte de mídia única (media_source=[NOME_FONTE]) como aparece no painel da 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

Fuso horário e moeda

timezone (opcional)

É possível obter os dados agregados através da Pull API em UTC ou no fuso horário preferencial do aplicativo, que é definido na página de configurações do aplicativo:

1. Adicione &timezone=[Joda-Time selecionado] ao link da API de pull para receber o relatório no fuso horário preferido do aplicativo (veja a observação abaixo)

2. Caso contrário, os dados são recebidos no fuso horário padrão UTC.

currency (opcional)

É usado para receber os dados de receita e custo na moeda selecionada, em vez de USD, que é a opção padrão. Isso é definido pelo administrador da conta.

currency=preferencial

é usado para receber dados de receitas e custos na moeda selecionada.

Política de API

A Política de API da AppsFlyer garante alta qualidade de serviço para os usuários da API de pull, limitando o número total de solicitações diárias e impedindo o abuso do serviço.

O número máximo de registros por relatório é 200.000. Se você receber um relatório com 200.000 linhas, então alguns resultados ficaram de fora.

Segurança da API

Todos os links da API de pull usam conexões https criptografadas e seguras.

Para mais detalhes, acesse aqui.

Exemplos de links da API de pull

Versão da API (V5)

• Alterações:

  • Nos relatórios de desempenho da versão (v5) que contêm múltiplos parceiros, são agrupados os dados do Facebook por campanha somente. Relatórios de desempenho que contêm apenas dados do Facebook (especificando &category=facebook) agrupam dados por campanha e grupo de anúncios.

  • A página de exportação de dados para relatórios agregados usa a versão da API (v5)

• Inalterado:

  • A API existente (v4) ainda está disponível para uso

  • A versão não aplica qualquer alteração ao formato de arquivo ou aos cabeçalhos

Dados agregados Protect360, conforme exibidos na tabela de detecção avançada no painel.

Parâmetros da API (obrigatório)

api_token

É a chave de autorização externa da API do usuário: "{Account owner API Key should be used}"

from (a partir de)

Data de início do relatório no formato "aaaa-mm-dd" ou "aaaa-mm-dd hh: mm". Por exemplo: 2010-01-01 ou 2010-01-01%2000%3A15 (o parâmetro de horas é para relatórios brutos apenas).

to (até)

Data final do relatório. Mesmo formato de a partir de

KPIs (obrigatório)

Os parâmetros Protect360 são os mesmos na Pull API e na Master API.

Para obter a lista de KPIs disponíveis e suas descrições, acesse aqui.

Parâmetros de filtragem da API (opcional)

Filtrar por fonte de mídia

É possível filtrar os relatórios para listar apenas uma fonte de mídia específica, adicionando:
pid=nome da fonte de mídia.

Fuso horário e moeda

timezone (opcional)

É possível obter os dados agregados P360 através da Pull API em UTC ou no fuso horário preferencial do aplicativo , que é definido na página de configurações do aplicativo:

1. Adicione &timezone=preferencial ao link da API de pull para receber o relatório no fuso horário preferencial do aplicativo

2. Caso contrário, os dados são recebidos no fuso horário padrão UTC.

currency (opcional)

É usado para receber os dados de receita e custo na moeda selecionada, em vez de USD, que é a opção padrão. Isso é definido pelo administrador da conta.

currency=preferencial

é usado para receber dados de receitas e custos na moeda selecionada.

Segurança da API

Todos os links da Pull API usam conexões https criptografadas e seguras.

Exemplos de links da API de pull

Observação: para ver todos os links de Pull API disponíveis: na Appsflyer, acesse Integration > API access (Integração > Acesso à API).

Versão da API (V5)

• Alterações:

  • Nos relatórios de desempenho da versão (v5) que contêm múltiplos parceiros, são agrupados os dados do Facebook por campanha somente. Relatórios de desempenho que contêm apenas dados do Facebook (especificando &category=facebook) agrupam dados por campanha e grupo de anúncios.

  • A página de exportação de dados para relatórios agregados usa a versão da API (v5)

• Inalterado:

  • A API existente (v4) ainda está disponível para uso

  • A versão não aplica qualquer alteração ao formato de arquivo ou aos cabeçalhos

Scripts para recuperar dados da API de pull

Muitas vezes é mais conveniente configurar scripts automatizados para recuperar dados periodicamente.

Abaixo você pode encontrar scripts para recuperar dados da API de pull. Os exemplos de scripts extraem dados do relatório de instalação. Edite os scripts para se adequar às suas necessidades em termos de qual relatório e quais dados você deseja recuperar.

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;
}
?>

Erros de API e solução de problemas

Esta seção discute erros comuns de API e como lidar com eles.