API do Chartboost — Métodos de análise

Última atualização:

 

O ponto de extremidade de análises de campanha fornece relatórios detalhados que podem ser agrupados por app ou criativo. Ao especificar um campo grupBy, um ID de tarefa será retornado pelo sistema de Análises em Fila, conforme detalhado na seção "Antes de começar".


Método HTTP GET
Ponto de extremidade https://analytics.chartboost.com/v3/metrics/campaign
Solicitação de exemplo https://analytics.chartboost.com/v3/metrics/campaign?dateMin={{Data mínima}}&dateMax={{Data máxima}}&userId={{ID de usuário do cliente Chartboost}}&userSignature={{assinatura de usuário do cliente CB}}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
aggregate String Opcional Agregar os resultados ao longo do tempo (diário, semanal, mensal) Diário
campaignId String Opcional ID da campanha (pode ser Para ID da campanha ou De ID da campanha com base em groupBy e função) N/D
campaignType String Opcional network, cross_promo, direct_deal network, direct_deal
dateMin String Necessário A data mínima (AAAA-MM-DD) N/D
dateMax String Necessário A data máxima (AAAA-MM-DD) N/D
groupBy String Opcional Um dos seguintes: 'country' 'app' 'app,creative' 'target_creative' 'date' 'campaign' 'campaign_target' 'campaign_type' Nenhum
platform String Opcional Filtrar por plataformas específicas (iOS, Google Play, Amazon) Tudo
role String Opcional advertiser ou publisher Ambos

Campos de resposta
Parâmetro Descrição Retornado para...
adTypeId 1 = interstitial
2 = more_apps
3 = in_play
4 = rewarded_video
5 = video_interstitial
Todos
app Nome do app Todos
campaign Nome da campanha Todos
campaignId ID da campanha (pode ser Para ID da campanha ou De ID da campanha com base em groupBy e função) Todos
campaignTarget Nome da meta da campanha (só é retornado ao agrupar por campaign_target) Anunciantes
campaignSubType user_acquisition ou retargeting Todos
clicksDelivered Cliques entregues Editoras
clicksReceived Cliques recebidos Anunciantes
cpcvEarned Proporção de dinheiro obtido de exibições de vídeo completas para exibições de vídeo completas Editoras
cpcvSpent Proporção de dinheiro gasto em exibições de vídeo completas para exibições de vídeo completas Anunciantes
creative Nome do criativo anunciado (só retornado ao agrupar por creative) Anunciantes
ctrDelivered Taxa de Clickthrough para impressões entregues Editoras
ctrReceived Taxa de Clickthrough para impressões recebidas Anunciantes
dt Data (AAAA-MM-DD) Todos
ecpmEarned Rendimentos por 1.000 impressões Editoras
ecpmSpent Custo por 1.000 impressões Anunciantes
impressionsDelivered Impressões fornecidas pela editora Editoras
impressionsReceived Impressões recebidas pelo anunciante Anunciantes
installDelivered Instalações entregues Editoras
installRateDelivered Taxa de instalação Editoras
installRateReceived Taxa de instalação Anunciantes
installReceived Instalações Anunciantes
moneyEarned Dinheiro obtido Editoras
moneySpent Dinheiro gasto Anunciantes
videoCompletedDelivered Visualizações de vídeo completas entregues Editoras
videoCompletedReceived Visualizações de vídeo completas recebidas Anunciantes

▲ Voltar para o topo

 

O ponto de extremidade de análises do app fornece relatórios detalhados que podem ser agrupados por app, tipo de anúncio ou local do anúncio.


Método HTTP GET
Ponto de extremidade https://analytics.chartboost.com/v3/metrics/app
Solicitação de exemplo https://analytics.chartboost.com/v3/metrics/app?dateMin={{Data mínima}}&dateMax={{Data máxima}}&userId={{ID de usuário do cliente Chartboost}}&userSignature={{assinatura de usuário do cliente CB}}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
aggregate String Opcional Agregar os resultados ao longo do tempo (diário, semanal, mensal) Diário
appId String Opcional Um ou mais IDs de app (separados por vírgula) Tudo
dateMax String Necessário A data máxima (AAAA-MM-DD) N/D
dateMin String Necessário A data mínima (AAAA-MM-DD) N/D
groupBy String Opcional Um dos seguintes: app, ad_type,app, date, ad_location (somente Editoras), platform, campaign_type Nenhum
platform String Opcional Qualquer um dos seguintes: iOS, Google Play, Amazon Tudo
role String Opcional advertiser ou publisher Ambos

Campos de resposta
Parâmetro Descrição Retornado para...
ad_Type Tipo de anúncio criativo
Saiba mais sobre tipos de anúncios ▶
Todos, somente quando groupBy=ad_type,app
allInstalls Número de instalações totais acumuladas, não importando a origem (Chartboost ou outra) Todos
app Nome do app Todos
appBundleId Não é mais enviado; o usuário verá Obsoleto nos relatórios Todos
appId ID do app Chartboost Todos
bootups Número de vezes que um usuário inicia o seu app em um dispositivo Todos
campaignType network, cross_promo, direct_deal Todos
clicksDelivered Cliques entregues Editoras
clicksReceived Cliques recebidos Anunciantes
cpcvEarned Proporção de dinheiro obtido de exibições de vídeo completas para exibições de vídeo completas Editoras
cpcvSpent Proporção de dinheiro gasto em exibições de vídeo completas para exibições de vídeo completas Anunciantes
ctrDelivered Taxa de Clickthrough para impressões entregues Editoras
ctrReceived Taxa de Clickthrough para impressões recebidas Anunciantes
dt Data (AAAA-MM-DD) Todos
ecpmEarned Rendimentos por 1.000 impressões Editoras
ecpmSpent Custo por 1.000 impressões Anunciantes
eventLocation O local nomeado do Chartboost do anúncio sendo publicado no app. Os anunciantes verão default no campo de resposta. Todos
impressionsDelivered Impressões fornecidas pela editora Editoras
impressionsReceived Impressões recebidas pelo anunciante Anunciantes
installDelivered Instalações entregues Editoras
installRateDelivered Taxa de instalação Editoras
installRateReceived Taxa de instalação Anunciantes
installReceived Instalações Anunciantes
moneyEarned Dinheiro obtido Editoras
moneySpent Dinheiro gasto Anunciantes
platform iOS, Google Play ou Amazon Todos
uniques Número de dispositivos exclusivos que inicializaram o app Todos
videoCompletedDelivered Visualizações de vídeo completas entregues Editoras
videoCompletedReceived Visualizações de vídeo completas recebidas Anunciantes

▲ Voltar para o topo

 

O ponto de extremidade de exportar instalações fornece uma lista completa de todas as instalações recebidas e/ou fornecidas. Note que esse ponto de extremidade sempre retornará um ID de tarefa do sistema de análises em fila, conforme detalhado na seção "Antes de começar".


Método HTTP GET
Ponto de extremidade https://analytics.chartboost.com/v3/metrics/install
Solicitação de exemplo https://analytics.chartboost.com/v3/metrics/install?dateMin={{Data mínima}}&dateMax={{Data máxima}}&userId={{ID de usuário do cliente Chartboost}}&userSignature={{assinatura de usuário do cliente CB}}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
campaignIds String Opcional Um ou mais IDs de campanha (separados por vírgula) Todas as campanhas
campaignType String Opcional network, cross_promo ou direct_deal Tudo
dateMax String Necessário A data máxima (AAAA-MM-DD) N/D
dateMin String Necessário A data mínima (AAAA-MM-DD) N/D
platform String Opcional Qualquer um dos seguintes: iOS, Google Play, Amazon Tudo
role String Opcional advertiser ou publisher Ambos

Campos de resposta
Parâmetro Descrição Retornado para...
Tipo de anúncio Tipo de anúncio criativo
Saiba mais sobre tipos de anúncios ▶
Todos
Carimbo de data e hora do clique Data e hora (DD-MM-AAAA HH:MM:SS) Todos
Tipo de custo Tipo de lance de publicidade
Saiba mais sobre tipos de lances ▶
Todos
Valor de custo Valor do lance de publicidade Todos
País Código de país de duas letras do dispositivo Todos
Data Data e hora (DD-MM-AAAA HH:MM:SS) Todos
Pacote do app de origem ID do pacote do app de publicação Todos
ID do app de origem ID do app de publicação Todos
Nome do app de origem Nome do app de publicação Todos
ID da campanha de origem ID da campanha de publicação Editoras
Nome da campanha de origem Nome da campanha de publicação Editoras
Tipo da campanha de origem network, cross_promo, direct_deal Editoras
GAID Google Advertising ID Todos (Somente Editora se o direcionamento comportamental estiver desativado)
IFA Identificador iOS para anunciantes (se o limite de acompanhamento de anúncio do iOS 10 estiver desativado) Todos (Somente Editora se o direcionamento comportamental estiver desativado)
MAC Endereço MAC (obsoleto) N/D
Modelo Modelo do dispositivo Todos
Sistema operacional Sistema operacional do dispositivo Todos
Pacote do app de destino ID do pacote do app de publicidade Todos
ID do app de destino ID do app de publicidade Todos
Nome do app de destino Nome do app de publicidade Todos
ID da campanha de destino ID da campanha de publicidade Anunciantes
Nome da campanha de destino Nome da campanha de publicidade Anunciantes
Meta da campanha de destino ID da meta da campanha de publicidade Todos
Tipo de campanha de destino network, cross_promo, direct_deal Anunciantes
UUID Identificador exclusivo universal do dispositivo (se disponível) Todos (Somente Editora se o direcionamento comportamental estiver desativado)

▲ Voltar para o topo

 

Além dos pontos de extremidade que você encontra na página API Explorer do painel, nós construímos um especialmente projetado para retornar dados de análise limpos no nível de app, data e país. Este ponto de extremidade também pode ser usado em nome dos clientes do Chartboost por serviços de atribuição e mediação de terceiros que necessitam de dados no nível do país.

Nota para redes de mediação: Nós recomendamos que você omita o campo campaignType, pois a API retornará automaticamente os resultados para network,direct_deal.
Dados de MoreApps não estão inclusos nesta API. Note que poderá haver uma discrepância entre pontos de extremidade de app e campanha e as suas análises do painel. Use o ponto de extremidade de campanha e agrupe por country para recuperar dados de app, country e ad_type.

Método HTTP GET
Ponto de extremidade https://analytics.chartboost.com/v3/metrics/appcountry
Solicitação de exemplo https://analytics.chartboost.com/v3/metrics/appcountry?dateMin={{Data mínima}}&dateMax={{Data máxima}}&userId={{ID de usuário do cliente Chartboost}}&userSignature={{Assinatura de usuário do cliente CB}}

Parâmetros
Parâmetro Tipo de solicitação Necessário? Descrição Padrão
appIds String Opcional Um ou mais IDs de app (separados por vírgula) Todos os apps
dateMin String Necessário A data mínima (AAAA-MM-DD) N/D
dateMax String Necessário A data máxima (AAAA-MM-DD) N/D
campaignType String Opcional network, cross_promo ou direct_deal network,direct_deal
adTypeIds String Opcional Um ou mais IDs de tipo de anúncio (separados por vírgula): 1 = interstitial, 3 = in_play, 4 = rewarded_video, 5 = video_interstitial 1,4,5
role String Opcional advertiser ou publisher publisher
adLocation String Opcional Um ou mais adLocations
(separados por vírgula)
  • Caso 1: (adLocation=<valor que não é 'all'>) mostra resultados agregados por cada adLocation apresentados SOMENTE para esse(s) adLocation(s). Informações para qualquer adLocation(s) só estão disponíveis se adLocation(s) for um dos melhores 3 adLocations usados pelo app da editora. Nenhum dado é retornado para os adLocation(s) restantes.
  • Caso 2: (adLocation='all') mostra o resultado detalhado em até os 3 melhores adLocation(s) para um app de editora, com os dados restantes agregados em adLocation = 'other'
  • Caso 3: (adLocation= vazio ou não passado) carrega todos os dados em adLocation = 'overall'. Não há detalhamento fornecido por adLocation.
veja o caso #3

Campos de resposta
Parâmetro Descrição Retornado para...
adLocation O local nomeado do Chartboost do anúncio sendo publicado no app. Os anunciantes verão padrão no campo de resposta. Todos
adType interstitial, rewarded_video, video_interstitial Todos
app Nome do app Todos
campaignType network, cross_promo, direct_deal Todos
clicksDelivered Cliques Editoras
clicksReceived Cliques Anunciantes
countryCode Código do país de duas letras, ou "desconhecido" Todos
cpcvEarned Proporção de dinheiro obtido de exibições de vídeo completas para exibições de vídeo completas Editoras
cpcvSpent Proporção de dinheiro gasto em exibições de vídeo completas para exibições de vídeo completas Anunciantes
ctrDelivered Taxa de cliques Editoras
ctrReceived Taxa de cliques Anunciantes
dt Data (AAAA-MM-DD) Todos
ecpmEarned Rendimentos por 1.000 impressões Editoras
ecpmSpent Custo por 1.000 impressões Anunciantes
impressionsDelivered Impressões Editoras
impressionsReceived Impressões Anunciantes
installRateDelivered Taxa de instalação Editoras
installRateReceived Taxa de instalação Anunciantes
installsDelivered Instalações Editoras
installsReceived Instalações Anunciantes
moneyEarned Dinheiro obtido Editoras
moneySpent Dinheiro gasto Anunciantes
platform iOS, Google Play ou Amazon Todos
videoCompletedDelivered Visualizações de vídeo completas Editoras
videoCompletedReceived Visualizações de vídeo completas Anunciantes

▲ Voltar para o topo

 


Você também pode se interessar...