API de relatório 1.0 para anunciantes

Visão geral

Nota: a API de relatório 1.0 é nossa API obsoleta. Use-a para relatórios sobre transações anteriores a 5 de julho de 2017. Para transações a partir de 5 de julho de 2017, use a API de relatório 2.0, documentada aqui.

A API de relatório oferece aos anunciantes um modo programático de acessar dados apresentados no painel. Sua Chave de API de relatório será 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 Cabeçalhos de solicitação API
https://ssl.vungle.com Content-Type: application/json A segurança ocorre ao passar uma chave de API como um parâmetro de consulta. Sua chave de API é gerada automaticamente no Painel Vungle.  
Se ainda não tiver uma, veja Como solicitar uma chave de API de relatório?

Anunciantes

Recurso Parâmetros Descrição
GET /api/campaigns key=[API Key] active=[true/false] Retorna uma lista das suas campanhas. Se estiver especificado 'ativa', as campanhas serão filtradas para exibir somente as ativas ou inativas.

Exemplo de resposta:

{   
    "rate" : 0.01,
    "rateType" : "complete",
    "campaignId" : "51896da23436ae313c3939b9",
    "type" : "external",
    "name" : "Feed the Rat",
    "spent" : 2131
}

Recurso Parâmetros Descrição
GET /api/campaigns/[Campaign ID] key=[API Key] date=[YYYY-MM-DD] Retorna as estatísticas da campanha especificada na data especificada.

Exemplo de resposta:

{
    "clicks" : 1129,
    "completedViews" : 23080,
    "date" : "2012-08-19",
    "campaignId" : "51896da23436ae313c3939b9",
    "installs" : 590,
    "impressions" : 26722,
    "name" : "Feed the Rat",
    "views" : 26546,
    "dailySpend": 566
}
Recurso Parâmetros Descrição
GET /api/campaigns/[Campaign ID]/installs key=[API Key] start=[YYYY-MM-DD] end=[YYYY-MM-DD] Retorna uma lista das instalações que foram atribuídas à campanha especificada durante a faixa de datas especificada.

Exemplo de resposta:

{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
},
{
    "time_clicked": "2012-08-17T01:52:32.024Z",
    "time_installed": "2012-08-17T01:54:33.034Z",
    "openUDID": "e2c42c159286124f34702e770cc702240c2707e8",
    "mac": "98d6bb786fdd"
}

Métricas de nível geográfico

Recurso Parâmetros Descrição
GET /api/campaigns/[Campaign ID]/geo/[Country_Code] key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Retorna as informações geográficas para uma campanha em determinados países. O país é especificado por um código de país de duas letras como US. Você pode inserir uma faixa de datas usando os parâmetros 'inicial' e 'final' ('start' e 'end') mas não ambos.

Exemplo de resposta:

{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
}
Recurso Parâmetros Descrição
GET /api/campaigns/[Campaign ID]/geo/all key=[API Key] date=[YYYY-MM-DD] OR start=[YYYY-MM-DD] end=[YYYY-MM-DD]

Retorna as informações geográficas para uma campanha em todos os países. Você pode inserir uma faixa de datas usando os parâmetros 'inicial' e 'final' ('start' e 'end') mas não ambos.

Exemplo de resposta:

[
{
"date": "2015-07-08",
"country": "US",
"views": 34029,
"completes": 32094,
"clicks": 1822,
"installs": 609,
"spend": 582,
"eRPM": 8.9
},
{
"date": "2015-07-08",
"country": "CA",
"views": 34235,
"completes": 3190,
"clicks": 1509,
"installs": 523,
"spend": 498,
"eRPM": 7.6
}
]

Observe que se não existem dados disponíveis para sua consulta, será retornada uma resposta 200 vazia. Isto indica que a solicitação foi bem sucedida, mas não existem dados disponíveis para retorno.

Tem mais dúvidas? Envie uma solicitação

Comentários