Global Statistics API
Esta seção é a descrição.
Nota: Os itinerários da API de estatísticas foram renomeados:
- /estatísticas/anunciante/... -> /statistics/a/...
- /statistics/publisher/... -> /statistics/p/...
Nota: A API de estatísticas globais mostra apenas as consultas RTB ignoradas para Data, Sites, Zonas, Países, Regiões e Sub IDs.
| Parâmetro | Descrição | Notas | Tipo |
|---|---|---|---|
| contagem | Retorna apenas total de resultados | inteiro | facultativo |
| pormenorizado | Se possível, obter mais pormenores. | inteiro | facultativo |
| fuso horário | Definição do fuso horário para o filtro "hora" e "grupo_por | corda | facultativo |
| totais | Indica se os totais devem ser adicionados à resposta ou não. | inteiro | facultativo |
| filtro | Filtros para restringir os valores devolvidos de uma consulta de estatísticas | objeto | facultativo |
| grupo_por | Uma lista de valores de "group by" a aplicar nos dados. São permitidos no máximo quatro. | matriz | obrigatório |
| ordem_por | Ordenação dos resultados por campo(s) específico(s). São permitidos no máximo dois. | matriz | facultativo |
| projeção | Subestruturas individuais que um utilizador pretende que sejam devolvidas na resposta. | matriz | facultativo |
| limite | O número de registos a devolver nesta resposta. | inteiro | facultativo |
| compensar | A posição a partir da qual se pretende obter os registos. | inteiro | facultativo |
Contagem de parâmetros
| Imóveis | contagem |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 0 |
| Valores disponíveis | [0, 1] |
| Descrição | Retorna apenas total de resultados |
Exemplo:
{
"count": 1
}
Parâmetro pormenorizado
| Imóveis | pormenorizado |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 0 |
| Valores disponíveis | [0, 1] |
| Descrição | Se deve ou não devolver informações pormenorizadas. |
Exemplo:
{
"detailed": 1
}
Parâmetro fuso horário
Definição do fuso horário para o filtro hour e group_by.
| Imóveis | fuso horário |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | América/Nova Iorque |
| Valores disponíveis | Definir campo de fuso horário de / colecções / fusos horários |
| Descrição | NOTA: Os fusos horários só são relevantes quando estamos a consultar com base em dados horários; para dados não horários, isto não é possível. |
Exemplo:
{
"timezone": "Europe/Dublin"
}
Totais dos parâmetros
| Imóveis | totais |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 0 |
| Valores disponíveis | [0,1] |
| Descrição | Indica se os totais devem ser adicionados à resposta ou não. |
Exemplo:
{
"totals": 1
}
Filtro de parâmetros
| Imóveis | filtro |
| Tipo | facultativo |
| Tipo de variável | objeto |
| Opção disponível para anunciantes | ["adblock", "advertiser_ad_type_id", "browser_id", "carrier_id", "category_id", "country_iso", "date_from", "date_to", "device_id", "device_type_id", hour", "language_id", "operating_system_id", "region_id", "site_hostname", "site_id", "size", "sub", "zone_id", "campaign_id", "exclude_deleted", "offer_id", "offer_landing_page_id", "variation_id"] |
| Opção disponível para os editores | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "date_from", "date_to", "device_id", "device_type_id", "hour", "language_id", "operating_system_id", "region_id", "site_hostname", "site_id", "zone_id", "publisher_ad_type_id", "size", "sub"] |
| Descrição | Filtrar por determinados parâmetros. |
Filtro: country_iso
| Imóveis | país_iso |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | - |
| Valores disponíveis | Analize a propriedade iso3 do método /collections/countries |
| Descrição | Lista de códigos ISO 3 |
Exemplo:
{
"filter": {
"country_iso": ["ESP", "IRL"]
}
}
Filtrar data_de, data_até
Os parâmetros date_from e date_to controlam a janela sobre a qual se pretende obter informação sobre as estatísticas.
- date_from: Intervalo de datas para as estatísticas (por defeito, início do mês),
- date_to: Intervalo de datas para as estatísticas, (Predefinição: hoje)
| Imóveis | data_de, data_até |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | As datas são predefinidas para o mês atual. |
| Valores disponíveis | AAAA-mm-dd |
| Descrição | Intervalo de datas de/até para as estatísticas. Formato AAAA-mm-dd |
Exemplo:
{
"filter": {
"date_from": "2019-02-25",
"date_to": "2019-02-28"
}
}
Os fusos horários só são relevantes quando estamos a consultar com base em dados horários; para dados não horários, isto não é possível.
Filtro: advertiser_ad_type_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, publisher_ad_type_id
| Imóveis | advertiser_ad_type_id, campaign_id, browser_id, carrier_id, category_id, device_id, device_type_id, language_id, offer_id, offer_landing_page_id, operating_system_id, hour, region_id, site_id, sub, variation_id, zone_id, advertiser_ad_type_id, publisher_ad_type_id |
| Tipo | facultativo |
| Tipo de variável | matriz |
| Tipo de itens | inteiro |
| Valor por defeito | - |
| Valores disponíveis | Propriedades relativas OU colecções |
| Descrição | Lista de Ids de entidades |
Exemplo:
{
"filter": {
"campaign_id": [123, 456],
"browser_id": [789]
}
}
Filtro: exclude_deleted
| Imóveis | exclude_deleted |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 0 |
| Valores disponíveis | [0, 1] |
| Descrição | Se deve ou não excluir campanhas eliminadas. |
Exemplo:
{
"filter": {
"exclude_deleted": 1
}
}
Filtro: adblock
| Imóveis | bloqueador de anúncios |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | "todos" |
| Valores disponíveis | "adblock", "todos", "padrão" |
| Descrição | Incluir ou não zonas de bloqueio de anúncios. |
Exemplo:
{
"filter": {
"adblock": "standard"
}
}
Filtro: site_hostname
| Imóveis | nome_do_site |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | - |
| Valores disponíveis | Os caracteres válidos para os nomes de anfitrião são as letras de a a z, os dígitos de 0 a 9, o hífen e o ponto. |
| Descrição | Filtrar por nome de anfitrião do site. |
Exemplo:
{
"filter": {
"site_hostname": ["www.example.com", "www.example-site.org"]
}
}
Filtro: size
| Imóveis | tamanho |
| Tipo | facultativo |
| Tipo de variável | corda |
| Valor por defeito | - |
| Valores disponíveis | Os caracteres válidos para o tamanho são os dígitos de 0 a 9 e o carácter x. Exemplo: 300x100 |
| Descrição | Filtrar por tamanho |
Exemplo:
{
"filter": {
"size": ["300x100"]
}
}
Parâmetro group_by
| Imóveis | grupo_por |
| Tipo | obrigatório |
| Tipo de variável | matriz |
| Tipo de itens | corda |
| Valor por defeito | - |
| Valores disponíveis para os anunciantes | ["adblock", "advertiser_ad_type_id", browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "date", "hour", "device_id", "device_type_id", "language_id", "operating_system_id", "region_id", "site_id", "sub", "zone_id", "week", "month", "quarter", "year", "offer_id", "offer_landing_page_id", "site_hostname", "size", "variation_id"] |
| Valores disponíveis para Editores | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "date", "device_id", "device_type_id", "hour", "language_id", "operating_system_id", "publisher_ad_type_id" "region_id", "site_id", "size", "sub", "zone_id", "week", "month", "quarter", "year"] |
| Descrição | Uma lista de sub-solicitações para incluir dados adicionais na resposta. |
Exemplo:
{
"group_by": [
"browser",
"date"
]
}
Parâmetro order_by
| Imóveis | ordem_por |
|---|---|
| Tipo | facultativo |
| Tipo de variável | matriz |
| Tipo de itens | corda |
| Valor por defeito | - |
| Valores de campo de métricas disponíveis | ["cpc", "cpc", "cpm", "cpv", "ctr", "clicks", "impressions", "video_impressions", "video_views", "vtr", "rtb_win_ratio", "rtb_avg_total_time", "rtb_skipped", "rtb_bid_response_ratio", "rtb_avg_cpm", "rtb_timeouts_ratio", "rt_errors_ratio", "rtb_no_bid_ratio", "rtb_skipped_ratio"] |
| Valores de campo disponíveis dependentes de `group_by' para Anunciantes | ["adblock", "browser_id", "campaign_id", "carrier_id", "category_id", "country_iso", "device_id", "date", "device_type_id", "hour", "ecpa1", "g1", "language_id", "month", "offer_id", "offer_landing_page_id", "operating_system_id", "quarter", "region_id", "site_hostname", "site_id", "sub", "variation_id", "week", "year" , "zone_id"] |
| Valores de campo disponíveis dependentes de `group_by' para Editores | ["adblock", "browser_id", "carrier_id", "category_id", "country_iso", "device_id", "date", "device_type_id" , "hour", "language_id", "month", "operating_system_id", "quarter", "region_id", "site_id", "sub", "week", "year", "zone_id"] |
| Valores de encomenda disponíveis | ["asc", "desc"] |
| Descrição | Uma lista de opções disponíveis para encomendar por |
Dicas:
- Os campos de métricas estão sempre disponíveis para serem utilizados como campo de ordenação.
- Para ordenar por um valor específico (por exemplo, por "browser_id"), é necessário incluí-lo no parâmetro "group_by".
Os valores "g1", "ecpa1" só estão disponíveis quando o utilizador tem Acompanhamento de conversões (Objectivos). Todos os objectivos estão associados a um número de série (g1, g2, ...gx). Os valores eCPA são, por conseguinte, ecpa1, ecpa2, ...ecpax.
Exemplo:
{
"order_by": [
{
"field": "impressions",
"order": "desc"
}
]
}
Por exemplo, para organizar os resultados da campanha por ordem cronológica, a "data" tem de ser incluída em "group_by" e "order_by":
{
"group_by": [
"campaign_id",
"date"
],
"order_by":[
{
"field": "date",
"order": "asc"
}
]
}
Projeção de parâmetro
O parâmetro de projeção reflete o que será retornado no payload resultante. Se não for especificado, todas as subestruturas serão retornadas.
| Imóveis | projeção |
|---|---|
| Tipo | facultativo |
| Tipo de variável | objeto |
| Tipo de itens | matriz |
| Valor por defeito | todas as opções, ver abaixo |
| Valores de campo disponíveis para Anunciantes | ["base", "rtb", "vídeo", "objectivos*"] |
| Valores de campo disponíveis para Editores | ["base", "rtb", "video", "wpn"] |
Alguns campos
Exemplos:
Para receber todas as métricas possíveis como anunciante, use:
{
"projection": {
"base": ["*"],
"video": ["*"],
"goals": ["*"],
"rtb": ["*"]
}
}
Para receber todas as métricas possíveis como editor, use:
{
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
}
}
Também pode especificar as métricas dentro de cada campo de projeção.
{
"projection": {
"base": ["impressions","clicks","cost","revenue","cpc","cpm","ctr"],
"video": ["impressions","views","cpv","vtr"],
"rtb": ["total_time","queries","value","success","no_bid","skipped","errors","timeouts","wins","win_ratio"],
//only for Publishers
"wpn": ["subscriptions","unsubscriptions","sent"]
}
}
O único campo que não permite métricas específicas de projeção é o "goals"
Limite do parâmetro
O número de registos a devolver nesta resposta.
| Imóveis | limite |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 50 |
Exemplo:
{
"limit": 25
}
Offset do parâmetro
A posição a partir da qual se pretende obter os registos.
| Imóveis | compensar |
| Tipo | facultativo |
| Tipo de variável | inteiro |
| Valor por defeito | 0 |
Exemplo
{
"offset": 150
}
Exemplo 1
Estatística de campanha do anunciante com filtragem.
Pedido:
{
"detailed": true,
"totals": 1,
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["campaign_id"],
"order_by": [
{
"field": "campaign_id",
"order": "desc"
}
]
"projection": {
"base": ["*"],
"video": ["*"],
"rtb": ["*"]
},
"limit": 2,
"offset": 0
}
Resposta:
{
"request_metadata": {
"count": 4,
"limit": 2,
"offset": 0
},
"result": [
{
"clicks": 0,
"cost": 1.3302,
"cpc": 0,
"cpm": 0.45586017820425,
"ctr": 0,
"group_by": {
"campaign_id": {
"active": "1",
"campaign_ad_type_name": "Popunders",
"id": "1234567",
"name": "Ron Mainstream Campaign "
}
},
"impressions": 2918,
"rtb": {
"avg_cpm": 0.15582967823432,
"avg_total_time": 89.522714492492,
"errors": 112,
"errors_ratio": 0.011368411650186,
"no_bid": 870594,
"no_bid_ratio": 88.368490823053,
"queries": 985186,
"response_ratio": 11.57101298638,
"skipped": 0,
"skipped_ratio": 0,
"success": 984590,
"timeouts": 484,
"timeouts_ratio": 0.049127778916875,
"total_time": 88196525,
"value": 1776.396,
"win_ratio": 0.29842080581738,
"wins": 2940
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 18.1621655,
"cpc": 0,
"cpm": 1.8273634671496,
"ctr": 0,
"group_by": {
"campaign_id": {
"active": "1",
"campaign_ad_type_name": "Popunders",
"id": "7654321",
"name": "Ron Mainstream Campaign Test"
}
},
"impressions": 9939,
"rtb": {
"avg_cpm": 1.4753505300475,
"avg_total_time": 88.777190144965,
"errors": 46,
"errors_ratio": 0.0014192869995779,
"no_bid": 3209674,
"no_bid_ratio": 99.031490893114,
"queries": 3241064,
"response_ratio": 0.8964340105595,
"skipped": 0,
"skipped_ratio": 0,
"success": 3238728,
"timeouts": 2290,
"timeouts_ratio": 0.070655809326814,
"total_time": 287732555,
"value": 4286.48343,
"win_ratio": 0.30665855410445,
"wins": 9939
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
],
"result_total": {
"clicks": 0,
"cost": 74.0473595,
"cpc": 0,
"cpm": 2.0864288391096,
"ctr": 0,
"impressions": 35490,
"rtb": {
"avg_cpm": 0.23441613972984,
"avg_total_time": 87.995789332859,
"errors": 539,
"errors_ratio": 0.0049868154705264,
"no_bid": 9771471,
"no_bid_ratio": 90.405422546568,
"queries": 10808501,
"response_ratio": 9.5135301370653,
"skipped": 0,
"skipped_ratio": 0,
"success": 10799741,
"timeouts": 8221,
"timeouts_ratio": 0.07606050089647,
"total_time": 951102577,
"win_ratio": 0.32861171035651,
"wins": 35518
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
}
Exemplo 2
Estatística do anunciante por data para o mês atual, ordenada por impressões.
Pedido:
{
"group_by": ["date"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
]
"projection": {
"base": ["*"],
"video": ["*"],
"rtb": ["*"]
}
}
Resposta:
{
"request_metadata": {
"count": 3,
"limit": 50,
"offset": 0
},
"result": [
{
"clicks": 0,
"cost": 624.2439917,
"cpc": 0,
"cpm": 1.0978015474007,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-02"
}
},
"impressions": 568631,
"rtb": {
"avg_cpm": 0.31273156270632,
"avg_total_time": 114.34705591799,
"errors": 4143,
"errors_ratio": 0.0076578188576312,
"no_bid": 48085697,
"no_bid_ratio": 88.8804144989,
"queries": 54101567,
"response_ratio": 10.971772776933,
"skipped": 0,
"skipped_ratio": 0,
"success": 54021598,
"timeouts": 75826,
"timeouts_ratio": 0.14015490530986,
"total_time": 6186354907,
"value": 185634.35958,
"win_ratio": 1.1633248996281,
"wins": 629377
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 622.1688691,
"cpc": 0,
"cpm": 1.1800128762878,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-01"
}
},
"impressions": 527256,
"rtb": {
"avg_cpm": 0.27775587567531,
"avg_total_time": 118.91585420372,
"errors": 2954,
"errors_ratio": 0.0078196779097434,
"no_bid": 32641750,
"no_bid_ratio": 86.407573260111,
"queries": 37776492,
"response_ratio": 13.412992397494,
"skipped": 0,
"skipped_ratio": 0,
"success": 37708708,
"timeouts": 64830,
"timeouts_ratio": 0.17161466448499,
"total_time": 4492223815,
"value": 140737.73563,
"win_ratio": 1.4077723257099,
"wins": 531807
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
},
{
"clicks": 0,
"cost": 441.843491,
"cpc": 0,
"cpm": 0.96186339096399,
"ctr": 0,
"group_by": {
"date": {
"date": "2019-03-03"
}
},
"impressions": 459362,
"rtb": {
"avg_cpm": 0.26462497173837,
"avg_total_time": 116.9210100884,
"errors": 2183,
"errors_ratio": 0.0059889808787451,
"no_bid": 32174177,
"no_bid_ratio": 88.268681100486,
"queries": 36450275,
"response_ratio": 11.500815837466,
"skipped": 0,
"skipped_ratio": 0,
"success": 36366256,
"timeouts": 81836,
"timeouts_ratio": 0.22451408116948,
"total_time": 4261802971,
"value": 110932.87869,
"win_ratio": 1.2852029237091,
"wins": 468460
},
"video": {
"cpv": 0,
"impressions": 0,
"views": 0,
"vtr": 0
}
}
]
}
Exemplo 3
Estatística do editor por data e region_id, ordenada por impressões.
Pedido:
{
"detailed": true,
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["date", "region_id"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
],
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
}
"limit": 30,
"offset": 0
}
Resposta:
{
"request_metadata": {
"count": 2,
"limit": 30,
"offset": 0
},
"result": [
{
"clicks": 3087,
"cpc": 0.033842716164561,
"cpm": 0.069188574849649,
"ctr": 0.20444155402072,
"group_by": {
"date": {
"date": "2019-03-11"
},
"region_id": {
"country_iso": "USA",
"country_long_name": "United States of America",
"country_short_name": "United States",
"id": 5332921,
"name": "California"
}
},
"impressions": 1494954,
"revenue": 104.4724648,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.038451404048583,
"impressions": 15013,
"views": 2717,
"vtr": 18.097648704456
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
},
{
"clicks": 3071,
"cpc": 0.03151133555845,
"cpm": 0.066658890819906,
"ctr": 0.21153940205505,
"group_by": {
"date": {
"date": "2019-03-10"
},
"region_id": {
"country_iso": "USA",
"country_long_name": "United States of America",
"country_short_name": "United States",
"id": 5332921,
"name": "California"
}
},
"impressions": 1436818,
"revenue": 96.7713115,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.036216808196108,
"impressions": 14921,
"views": 2672,
"vtr": 17.907646940554
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
}
]
}
Exemplo 4
Estatística do editor por site_id com projeção.
Pedido:
{
"detailed": true,
"projection": {
"base": ["*"],
"video": ["*"],
"wpn": ["*"],
"rtb": ["*"]
},
"filter": {
"date_from": "2019-03-10",
"date_to": "2019-03-11",
"country_iso": ["USA"]
},
"group_by": ["site_id"],
"order_by": [
{
"field": "impressions",
"order": "desc"
}
],
"limit": 30,
"offset": 0
}
Resposta
{
"request_metadata": {
"count": 2,
"limit": 30,
"offset": 0
},
"result": [
{
"clicks": 14320,
"cpc": 0.028298959692737,
"cpm": 0.057945765404939,
"ctr": 0.20476288186597,
"group_by": {
"site_id": {
"id": "11223344",
"name": "nice-example.com"
}
},
"impressions": 6916414,
"revenue": 405.2411028,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.031519102652252,
"impressions": 77041,
"views": 12857,
"vtr": 16.688516504199
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
},
{
"clicks": 14148,
"cpc": 0.028769196296296,
"cpm": 0.063791981699323,
"ctr": 0.22173710048179,
"impressions": 6314909,
"revenue": 407.0265892,
"rtb": {
"avg_cpm": 0,
"avg_total_time": 0,
"bid_response_ratio": 0,
"errors": 0,
"errors_ratio": 0,
"no_bid": 0,
"no_bid_ratio": 0,
"queries": 0,
"skipped": 0,
"skipped_ratio": 0,
"success": 0,
"timeouts": 0,
"timeouts_ratio": 0,
"total_time": 0,
"value": 0,
"win_ratio": 0,
"wins": 0
},
"video": {
"cpv": 0.036406671663685,
"impressions": 65620,
"views": 11180,
"vtr": 17.037488570558
},
"wpn": {
"subscriptions": 0,
"unsubscriptions": 0
}
}
]
}