How can we help?

Master API–métricas de aquisição de usuários via API Premium

  • Atualizado

Visão geral: receba KPIs selecionados de LTV, atividade, retenção, cohort e performance de campanha do Protect360 por API, em formato CSV ou JSON. Selecione um ou mais aplicativos.

Master API – métricas de aquisição de usuários via API

Master API:

  • Permite que você receba KPIs selecionados de LTV, atividade, retenção, cohort e performance de campanha do Protect360. Os KPIs disponíveis são KPIs equivalentes aos encontrados nos dashboards de Visão Geral, Atividade, Retenção, Cohort e Protect360.
  • Os cálculos são realizados diariamente. Os dados atualizados ficam disponíveis dentro de 24 a 48 horas, dependendo do fuso horário específico do seu aplicativo.
  • É a infraestrutura que comporta a pivot table da AppsFlyer. 

Para usar a Master API, você precisa definir os dados que deseja visualizar (semelhante à implementação da Pull API). O resultado é um arquivo CSV ou JSON. 

Para usar a Master API:

  1. AppsFlyerAdmin_us-en.pngObtenha o token da API. Um administrador precisa solicitar o token.
  2. Forneça ao seu desenvolvedor o token da API que será usado no header de autenticação.
  3. Forneça aos seus desenvolvedores os parâmetros que devem ser inseridos quando eles fizerem a chamada de API, conforme descrito nas seções a seguir. Os parâmetros determinam o foco do relatório e a maneira como ele é organizado, além de fornecerem um cronograma de relatórios.
  4. Diga ao seu desenvolvedor para seguir as instruções da Master API no developer hub.
  5. Parâmetros da API

    Parâmetro Valor Obrigatório
    ativado
    • Identificador do aplicativo (app ID), conforme encontrado na AppsFlyer.
    • Insira o app ID exatamente conforme encontrado na AppsFlyer
    • Coloque o prefixo id em apps do iOS
    • Use todos os app IDs para consultar todos os seus aplicativos
    Sim
    início

    Limite inferior do período de atribuição de LTV.

    • Formato: string aaaa-mm-dd
    • Exemplo: from: 2020-01-02
    Sim 
    to (até)

    Limite superior do período de atribuição de LTV

    • Número de dias no intervalo: 1 a 31 dias
    • Para um único dia: os valores from e to são idênticos. 
    • Formato: aaaa-mm-dd
    • Exemplo: from: 2021-01-01, to: 2021-01-31 são 31 dias.
     Sim
    Agrupamentos

    Agrupar por parâmetros, separados por vírgula. Consulte a tabela Agrupamentos para ver a lista disponível 

    Exemplo: groupings=pid,geo

     Sim
    KPIs

    Lista de KPIs que devem ser incluídos, separados por vírgula. Para acessar a lista de KPIs, veja a tabela abaixo.

    Exemplo: kpis=installs,clicks, impressions,sessions,retention_day_7

     Sim
    Filtros Os dados podem ser filtrados usando uma ou mais opções de filtro. Não
    Moeda Para retornar dados usando a moeda específica do aplicativo, defina currency=preferred Não
    Fuso horário Para retornar dados usando o fuso horário específico do aplicativo, defina timezone=preferred.  Veja as regras de localização  Não
    Formato Por padrão, os dados de resposta são recebidos no formato de arquivo CSV. Se preferir obter os dados no formato JSON, selecione format=json. Não

    Agrupamentos

    As dimensões abaixo são usadas para a coleta de dados, que são agrupados para uma análise mais rápida e precisa das informações recebidas. Você pode acessar as descrições dos campos aqui.

    Agrupar por
    Nome da API
    Agrupar por nome de exibição KPIs de LTV KPIs de retenção KPIs de atividade Os alertas do Protect360 são atualizados no horário UTC diário. Coorte
    ativado ID da aplicação Sim Sim Sim Sim Sim
    pid Canal de mídia Sim Sim Sim Sim Sim
    af_prt Agência Sim Sim Sim Sim Não
    C Campanha Sim Sim Sim Sim Sim
    af_adset Conjunto de anúncios Sim Sim Sim Não Não
    af_ad Anúncio Sim Sim Sim Não Não
    af_canal Canal Sim Sim Sim Sim Não
    af_siteid ID do editor Sim Sim Sim Sim Sim
    af_keywords Palavras-chave Sim Sim Sim Não Não
    is_primary É atribuição primária Sim Não Sim Sim Não
    af_c_id ID da campanha Sim Não Sim Sim Não
    af_adset_id Adset ID Sim Não Sim Não Não
    af_ad_id ID do anúncio Sim Não Sim Não Não
    install_time Data/hora da instalação Sim Sim Sim* Sim Sim
    tipo_de_toque_atribuído Tipo de toque Sim Sim Sim Sim Não
    geo Geolocalização Sim Sim Sim Sim Sim
    * No contexto dos KPIs de atividade, considere o tempo de instalação como o tempo do evento. 

    KPIs

    KPIs são as métricas usadas para obter insights sobre o comportamento do seu aplicativo. Os KPIs são agrupados por tipo nas abas a seguir.

    Dados de LTV: 5 anos

    Lifetime value - eventos agregados segmentados por data de instalação até hoje

    Nome do KPI na API  Descrição
    impressions Número de impressões dentro do período selecionado
    clicks Número de cliques dentro do período selecionado
    installs Número de instalações dentro do período selecionado
    cr Taxa de conversão
    sessions Número de sessões criadas por usuários que instalaram o app durante o período selecionado
    loyal_users Número de usuários fidelizados que instalaram o app durante o período selecionado
    loyal_users_rate Usuários fidelizados/instalações
    cost Custo total no período selecionado. Ver limitações
    revenue Receita vitalícia gerada por usuários que instalaram o app durante o período selecionado
    roi Retorno do investimento (ROI) durante um determinado período de tempo
    arpu_ltv Receita média por usuário, para usuários que instalaram o app durante o período selecionado
    average_ecpi Custo efetivo por instalação (eCPI) durante um determinado período. Disponível somente se o custo e as instalações estiverem incluídos na chamada. 
    uninstalls Usuários que desinstalaram o app, que inicialmente o instalaram durante o período selecionado
    uninstalls_rate Taxa de desinstalação
    event_counter_[event_name] Número de ocorrências de eventos
    unique_users_[event_name] Número de usuários únicos que realizaram o evento
    sales_in_usd_[event_name] Receita relatada como parte dos eventos registrados

    Retenção

    A retenção é uma métrica de quantos usuários existentes estão ativos no seu aplicativo.

    Observação: 

    • O número máximo de dias de retenção é 30 dias após a instalação, sendo o dia 0 o dia da instalação. Isso significa que o valor [x] não pode exceder 30. 
    • Se você solicitar "retention_day_1", antes que os dados desse dia estejam disponíveis, a métrica retornada estará relacionada aos usuários que fizeram a instalação no dia anterior. Por exemplo, em 2 de janeiro, você solicita "retention_day_1" para usuários que fizeram a instalação em 1 de janeiro. Como a métrica ainda não está disponível, a métrica retornada está relacionada aos usuários que fizeram a instalação em 31 de dezembro. 
    KPI Descrição
    retention_day_[x] Número de usuários retidos no dia X
    retention_rate_day_[x] Taxa de usuários retidos no dia X do total de usuários que instalaram o app

    ativado

    Atividade no aplicativo durante o período selecionado Atividade no aplicativo durante o período selecionado Observação: os KPIs de atividade incluem dados unificados (UA e retargeting juntos).

    KPI Descrição
    activity_average_dau Média de usuários ativos diários (DAU) durante o período selecionado
    activity_average_mau Média de usuários ativos mensais durante o período selecionado (os dados de MAU em determinado dia representam os usuários ativos nos últimos 30 dias)
    activity_average_dau_mau_rate Taxa média de DAU/MAU
    activity_average_arpdau Receita média por usuário diário ativo - a receita média de um determinado dia, obtida de cada usuário
    activity_sessions Número de sessões realizadas durante o período selecionado
    activity_revenue Receita relatada durante o período selecionado
    activity_event_counter_[event_name] Número de eventos gerados pelos usuários durante o período selecionado
    activity_sales_in_usd_[event_name] Receita relatada como parte dos eventos relatados durante o período selecionado
    activity_average_unique_users_[event_name]
     
    Média de usuários únicos que realizaram determinado evento durante o período selecionado

    Coorte

    Os cohorts da AppsFlyer permitem que os anunciantes visualizem a comparem diferentes métricas para vários cohorts em diferentes períodos de tempo.

    Observação:

    • Erros de arredondamento: os KPIs de cohort por usuário são calculados usando quatro casas decimais. Isso significa que, se o valor calculado por usuário for < 0,0001, isso será mostrado como 0. Por exemplo, o número de usuários é 100.000 e a receita total é de US$ 9. A receita por usuário é 9/100000=0,00009. Como 0,00009<0,0001, o valor mostrado será 0. 
    • Dias de cohort: o número máximo de dias de cohort é 90 dias após a instalação, em que o dia 0 é o dia da instalação. O valor do dia da cohort [x] deve estar no intervalo de 1 a 90.  Observação: cohort_day_0 não é compatível com a Master API, embora seja compatível com o dashboard de Cohort. 
    • Master API vs. Cohort API e dashboard de Cohort: os resultados podem diferir por conta das diferenças no tratamento de reinstalações e problemas de sincronização. 

    Sessões

    KPI Descrição
    cohort_day_[x]_total_sessions_per_user Cohort dia X - sessões cumulativas por usuário até o dia x (incluindo o dia x)
    cohort_day_[x]_sessions_per_user Cohort dia X - sessões no dia x realizadas somente pelo cohort em questão
    cohort_[x]_days_total_sessions_per_user

    Substitui a especificação de KPIs Cohort_day_1_total_sessions_per_user por Cohort_day_x_total_sessions_per_user na URL.

    Por exemplo: "cohort_3_days_total_sessions_per_user" na URL produz 3 colunas de relatório:
    Cohort_day_1_total_sessions_per_user+ Cohort_day_2_total_sessions_per_user+Cohort_day_3_total_sessions_per_user

    Resultados

    KPI Descrição
    cohort_day_[x]_total_revenue_per_user Cohort dia X - receita cumulativa por usuário até o dia x (incluindo o dia x)
    cohort_day_[x]_revenue_per_user Cohort dia X - ARPU recebido de um determinado cohort no dia x
    cohort_[x]_days_total_revenue_per_user

    Substitui a especificação de KPIs "Cohort_day_1_total_revenue_per_user" por "Cohort_day_x_total_revenue_per_user".

    Por exemplo: "cohort_3_days_total_revenue_per_user" na URL produz 3 colunas de relatório:
    Cohort_day_1_total_revenue_per_user+ Cohort_day_2_total_revenue_per_user+Cohort_day_3_total_revenue_per_user

    cohort_day_[x]_total_event_[eventname]_revenue_per_user Dia do cohort x receita acumulada por usuário de acordo com um evento in-app específico
    cohort_day_[x]_event_[eventname]_revenue_per_user Dia do cohort x receita por usuário de acordo com evento in-app específico

    Eventos

    KPI Descrição
    cohort_day_[x]_total_event_[eventname]_per_user Cohort dia X - eventos cumulativos por usuário até o dia x (incluindo o dia x)
    cohort_day_[x]_event_[eventname]_per_user Cohort dia X - eventos recebidos de um determinado cohort no dia x
    cohort_[x]_days_total_event_[eventname]_per_user

    Substitui a especificação de eventos de KPIs por "Cohort_day_x_total_events_per_user".

    Por exemplo: "cohort_3_days_total_events_per_user" na URL produz 3 colunas de relatório:
    Cohort_day_1_total_events_per_user+ Cohort_day_2_total_events_per_user+Cohort_day_3_total_events_per_user

    Os alertas do Protect360 são atualizados no horário UTC diário.

    KPIs do Protect360

    Descrição KPI 
    Instalações  
    Total protect360_total_installs
    Bloqueadas blocked_installs
    Bloqueadas (%) blocked_installs_rate
    Pós-atribuição instalações_pós_atribuição
    Pós-atribuição (%) taxa_de_instalações_pós_atribuição
    Total de instalações fraudulentas total_de_instalações_fraudulentas
    Instalações fraudulentas (%) taxa_de_instalações_fraudulentas
    Instalações falsas  
    Bloqueio em tempo real instalações_falsas_em_tempo_real
    Fraude pós-atribuição instalações_falsas_pós_atribuição
    Hijacking de instalações  
    Bloqueio em tempo real instalações_sequestradas_em_tempo_real
    Fraude pós-atribuição instalações_pós_atribuição_sequestradas
    Regras de validação  
    Instalações bloqueadas instalações_bloqueadas_por_regras_de_validação
    Atribuição bloqueada atribuição_bloqueada_por_regras_de_validação
    Detalhes do bloqueio de instalações falsas  
    Lista de exclusão de site IDs bloqueados blocked_installs_siteid_blacklist
    Lista de exclusão de site IDs pós-atribuição instalações_pós_atribuição_blacklist_de_siteid
    Bots bloqueados blocked_installs_bots
    Bots pós-atribuição instalações_pós_atribuição_bots
    Anomalias comportamentais bloqueadas instalações_bloqueadas_anomalias_comportamentais
    Anomalias comportamentais pós-atribuição instalações_pós_atribuição_anomalias_comportamentais
    Validação de instalações bloqueadas instalações_bloqueadas_validação_de_instalação
    Detalhes do bloqueio de hijackings de instalação  
    Hijacking de instalações bloqueados instalações_bloqueadas_sequestro_de_instalação
    Hijacking de instalação pós-atribuição pós-atribuição_instalações_sequestro_de_instalações
    Anomalias de CTIT bloqueadas blocked_installs_ctit_anomalies
    Anomalias de CTIT pós-atribuição pós-atribuição_instalações_anomalias_de_ctit
    Flooding de cliques bloqueados blocked_installs_click_flood
    Flooding de cliques pós-atribuição pós-atribuição_instalações_inundação_de_cliques
    Cliques  
    Total protect360_total_clicks
    Bloqueadas blocked_clicks
    % blocked_clicks_rate
    Eventos in-app  
    Total protect360_total_in_apps
    Bloqueadas blocked_in-app-events
    % blocked_in-app-events_rate
    Indicadores de device farm - novos dispositivos  
    Instalações fraude_de_instalação_novos_dispositivos_total
    Instalações (%) install_fraud_new_devices_total_installs_rate
    Usuários fidelizados (%) install_fraud_new_devices_total_loyal_user_rate
    Indicadores de device farm - dispositivos LAT  
    Instalações fraude_de_instalação_dispositivos_lat_total
    Instalações (%) fraude_de_instalação_dispositivos_lat_total_taxa_de_instalações
    Usuários fidelizados (%) fraude_de_instalação_dispositivos_lat_total_taxa_de_usuários_fiéis
    Indicadores de flooding de cliques  
    Taxa de conversão conversion_rate
    Indicadores de flooding de cliques - CTIT  
    Mais de 60 minutos inundação_de_cliques_mais_de_1_hora_taxa
    Mais de 5 horas inundação_de_cliques_mais_de_5_horas_taxa

    KPIs calculados

    Além dos KPIs descritos anteriormente, você pode adicionar KPIs calculados aos seus relatórios da Master API. Isso permite que você inclua seus próprios relatórios calculados em seus relatórios da Master API.

    Você pode inserir qualquer número de objetos de KPI integrados nas fórmulas de KPI calculadas. Cada cálculo de objeto de KPI inclui uma chave e um valor. A chave é o nome que você dá ao KPI e o valor é a fórmula do KPI.

    Operadores aritméticos padrão podem ser usados: adição (+) codificada como %2b, subtração (-), multiplicação (*), divisão (/) codificada como %2f.

    As chaves do campo de KPI calculado devem começar com "calculated_kpi_", seguido por qualquer sequência (string) válida, como "calculated_kpi_purchaserate".

     Exemplo

    Retenção combinada dos primeiros três dias

    kpis=installs,loyal_users_rate&calculated_kpi_3days_retention=
    retention_day_1%2Bretention_day_2%2Bretention_day_3

    Receita média por impressão

    kpis=installs&calculated_kpi_rev_per_impression=revenue%2Fimpression

    ROI do D7 da cohort

    kpis=installs,roi,arpu_ltv,cost,revenue&calculated_kpi_roi_day_7=
    (cohort_day_7_total_revenue_per_user-average_ecpi)%2Faverage_ecpi

    Filtros (opcional)

    Parâmetro Descrição Exemplo Obrigatório?
    pid
    • Usado para selecionar as linhas nas quais os canais de mídia especificados são exibidos.
    • É possível realizar seleção múltipla separada por vírgula.
    pid=organic,applovin_int Não
    C
    • Usado para filtrar por nome de campanha.
    • É possível realizar seleção múltipla separada por vírgula.
    c=my_sample_campaign Não
    af_prt
    • Usado para filtrar por nome de agência.
    • É possível realizar seleção múltipla separada por vírgula.
    af_prt=moburst Não
    af_canal
    • Usado para filtrar por nome de canal.
    • É possível realizar seleção múltipla separada por vírgula.
    af_channel=Instagram Não
    af_siteid
    • Usado para filtrar por publisher ID.
    • É possível realizar seleção múltipla separada por vírgula.
    af_siteid=12345678 Não
    geo
    • Usado para filtrar por país.
    • É possível realizar seleção múltipla separada por vírgula.
    geo=US,DE Não

    Localização

    A moeda local e o fuso horário específico do aplicativo são definidos na página de configurações do aplicativo. Os dados da Master API podem extrair dados usando a moeda e o fuso horário padrão do sistema ou usando o fuso horário e a moeda específicos do aplicativo. 

    O seguinte se aplica:

    • O uso do fuso horário/moeda específica do aplicativo só será possível se todos os aplicativos tiverem o mesmo fuso horário/moeda. Caso contrário, serão usados UTC e USD. O fuso horário e a moeda são separados. Isso significa que se a moeda de todos os aplicativos for a mesma, mas os fusos horários não, você poderá usar a moeda específica do aplicativo, mas não o fuso horário específico do aplicativo. 
    • Se o fuso horário preferencial tiver sido alterado no dashboard dentro do intervalo de tempo solicitado, o relatório gerado conterá valores a partir da alteração de fuso horário mais recente.

    Use os parâmetros a seguir para selecionar a configuração específica do aplicativo. Observação: se você não usar os parâmetros preferenciais, obterá as configurações padrão, que são USD para moeda e UTC para fuso horário. 

    Parâmetro Descrição Exemplo Obrigatório?
    símbolos monetários Valores monetários na moeda específica do aplicativo currency=preferencial Não
    Fuso horário O fuso horário usado está de acordo com o fuso horário específico do aplicativo timezone=preferred Não

Informações adicionais

Características e limitações

Caraterística Observações 
Dados de custo
  • Disponibilidade de diferentes dimensões de custo, o que significa que o conjunto de anúncios, o anúncio, a geolocalização, o canal e o ID do site dependem da ad network
  • Para obter o eCPI: se os dados de custo estiverem disponíveis, inclua as instalações e o custo na chamada. 
  • Em geral, todos os canais, incluindo mídia própria, que usam links da AppsFlyer e possuem o parâmetro de custo nos links, são totalmente compatíveis com os dados de custo, independentemente das dimensões solicitadas. Redes de autorrelato, que possuem uma API própria, geralmente são compatíveis com dados de custos, mas com apenas algumas das dimensões disponíveis. Por exemplo, Meta Ads não oferece suporte ao agrupamento por geolocalização e canal na mesma chamada. No entanto, é possível agrupá-los separadamente.
  • Campanhas que têm dados de custo, mas não têm dados de instalações no passado recente (aprox. 7 dias), não estão disponíveis via Master API.
Agrupamentos Agrupamentos específicos estão disponíveis apenas para KPIs de LTV, Atividade ou KPIs de Retenção. A API retorna N/A quando os dados de um KPI específico não estão disponíveis. Por exemplo, a solicitação "detention_rate_day_7" agrupada por "af_channel" retorna N/A.
Dados Para dados de coorte, se uma agência estiver envolvida na atribuição, o canal de mídia retornado será o nome da agência
Máximo de linhas por relatório 200 mil
Nomes de eventos A API Master atualmente não oferece suporte a nomes de eventos que incluam uma barra / . Para superar essa limitação, evite o usuário de / em nomes de eventos. 
Tempo de processamento Selecionar mais de um aplicativo aumenta o tempo de processamento e a resposta pode demorar mais.
Date range A granularidade do prazo é diária. 
Agências Master API não disponível
Redes de anúncios Master API não disponível
Dados históricos
  • Dados de LTV: 25 meses (2 anos + 1 mês)
  • Dados de coorte (coorte diária): 2 anos
  • Dados da atividade: 3 anos
Redirecionamento
  • Não compatível
  • Exceção: os KPIs de atividade para tráfego após 1 de fevereiro de 2025 incluem dados unificados (UA e retargeting juntos).

This article was translated using AI and may contain errors. For the most accurate information, please refer to the English version using the language selector.


Share article: