API de relatório 2.0 para anunciantes

Conteúdo

Visão geral

A API de relatório oferece aos editores um modo programático de acessar dados apresentados no painel. Sua Chave de API de relatório é a mesma para todos os seus aplicativos. Cada aplicativo tem um ID de API de relatório único, que você encontra em sua respectiva página do aplicativo.

Host

Host: https://report.api.vungle.com/ext/pub/reports/performance

Autenticação

A segurança é tratada no cabeçalho da solicitação. Encontre sua chave de API na página Relatórios em um painel Vungle. Se você ainda não tem uma chave de API, envie email para tech-support@vungle.com para solicitar uma!

Cabeçalhos de solicitação

Chave Valor Descrição
Authorization: Bearer [API Key] Chave de API
Vungle-Version: 1 Versão da API
Accept: text/csv or application/json Accepted data format for results. Default is text/csv.

 

Resultados

  • Formato: Suportamos saídas em JSON e CSV.
  • Faixa de data: Informação histórica está disponível para até seis meses. Para recuperar dados mais antigos, envie email para seu gerente de conta em tech-support@vungle.com.
  • Caso não existam dados: Observe que se não existem dados disponíveis para sua query, a Vungle retorna uma resposta 200 vazia. Isto indica que a solicitação foi bem sucedida, mas não existem dados disponíveis para retorno.

Recurso: GET /reports/performance

Parâmetros de filtro

Use parâmetros de filtro para restringir resultados de um sub-conjunto de seus dados de desempenho. Muitos filtros são opcionais, para os quais a Vungle retorna todos os resultados para aquele filtro.

Nome do parâmetro Formato Ação Se indisponível Exemplo
start Data ISO8601 Limita o conjunto de resultado de dados de desempenho a partir desta data Rejeita a solicitação start=2017-01-01
end Data ISO8601 Limita o conjunto de resultado de dados de desempenho até esta data Rejeita a solicitação end=2017-01-02 
country  Lista de códigos de país ISO 3166-1 Alpha-2 separados por vírgula Retorna apenas dados de desempenho que estejam nos países listados Retorna todos os países

country=US

country=US,CA

country=US,CA,AU
applicationId  Lista de IDs Vungle de aplicativo separados por vírgula para retorno Retorna apenas dados de desempenho que estejam nos aplicativos listados Retorna todos os aplicativos

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 Retorna apenas dados de desempenho de tráfego incentivado ou não incentivado Retorna dados de desempenho de tráfego incentivado e não incentivado

incentivized=true

incentivized=false

Parâmetro de dimensões

Use dimensões para tornar seus relatórios mais ou menos granulares. Envie as dimensões como uma lista separada por vírgula em um parâmetro dimensions. Se você não solicitar explicitamente uma dimensão, o Vungle não gera o relatório por aquela dimensão.

Uso do parâmetro de dimensões

Nome do parâmetro Formato Exemplo
dimensions Lista de strings específicas separada por vírgula, listada na tabela abaixo

dimensions=platform

dimensions=application,date,country

 

Dimensões disponíveis

Nome da 
dimensão
Retorna Retorno de exemplo
platform Agrupado por string de plataforma
platform
iOS
application Agrupado por ID e nome de Vungle de aplicativo
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
placement Agrupado por ID e nome de posicionamento
placement id placement name
12345678 Level 3
date  Agrupado por data 
date
2017-01-01
country Agrupado por país
country
US
incentivized Agrupado por tráfego incentivado
incentivized
true
false

Para dimensões que requerem um lookup de nome (por exemplo, nome do aplicativo), se a Vungle não consegue recuperar o lookup, retornamos uma string 'Desconhecida' no lugar do nome.

Parâmetro de agregação

Use agregações para definir quais dados de desempenho interessam a você. Envie as agregações como uma lista separada por vírgula em um parâmetro aggregates. Se uma agregação não está na lista, a Vungle assume que você não deseja receber aqueles dados.

Uso do parâmetro de agregações

Nome do parâmetro Formato Exemplo
aggregates Lista de strings específicas separada por vírgula, listada na tabela abaixo

aggregates=views

aggregates=views,installs,ecpm

 

Agregações disponíveis

Nome da 
dimensão
Retorna
views Inteiro
completes Inteiro
clicks  Inteiro
revenue  Inteiro
ecpm (receita do editor * 1000 / visualizações) como um ponto flutuante

  

Queries e respostas de exemplo

Exemplo 1: JSON Receita

Solicitação


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"

Resposta


[
    {
        "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,
    },
    ...
]

Exemplo 2: CSV Receita

Solicitação


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"

Resposta


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

Example 3: Placement

Solicitação

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"

Resposta


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0       
    }
]
Tem mais dúvidas? Envie uma solicitação

Comentários