For the complete documentation index, see llms.txt. This page is also available as Markdown.

API de Estatísticas Globais

Esta secção descreve os parâmetros de pedido e os dados de resultado da API de Estatísticas Globais.

As rotas da API de estatísticas foram renomeadas:

  • /statistics/advertiser/... -> /statistics/a/...

  • /statistics/publisher/... -> /statistics/p/...

A API de Estatísticas Globais só mostra consultas RTB ignoradas para Data, Sites, Zonas, Países, Regiões e Sub IDs.

Parâmetro
Descrição
Notas
Tipo

contagem

Devolver apenas o total dos resultados.

inteiro

opcional

detalhado

Obter mais detalhes, se possível.

inteiro

opcional

fuso horário

Configuração de fuso horário para o filtro 'hour' e 'group_by'

cadeia de caracteres

opcional

totais

Indica se devem ser adicionados totais à resposta ou não.

inteiro

opcional

filtro

Filtros para restringir os valores devolvidos de uma consulta de estatísticas

objeto

opcional

group_by

Uma lista de valores group by a aplicar nos dados. São permitidos no máximo quatro.

array

obrigatório

order_by

Ordenação dos resultados por campo(s) específico(s). São permitidos no máximo dois.

array

opcional

projection

Subestruturas individuais que o utilizador deseja receber na resposta.

array

opcional

limit

O número de registos a devolver nesta resposta.

inteiro

opcional

offset

A posição a partir da qual recuperar os registos.

inteiro

opcional

Contagem do parâmetro

Propriedade

contagem

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

0

Valores disponíveis

[0, 1]

Descrição

Devolver apenas o total dos resultados.

Exemplo:

Parâmetro detailed

Propriedade

detalhado

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

0

Valores disponíveis

[0, 1]

Descrição

Se deve ou não devolver informação detalhada.

Exemplo:

Parâmetro timezone

Configuração de fuso horário para hour filter e group_by.

Propriedade

fuso horário

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

America/New_york

Valores disponíveis

Defina o campo de fuso horário de / collections / timezones

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 tem efeito.

Exemplo:

Parâmetro totals

Propriedade

totais

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

0

Valores disponíveis

[0,1]

Descrição

Indica se devem ser adicionados totais à resposta ou não.

Exemplo:

Parâmetro filter

Propriedade

filtro

Tipo

opcional

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_group_id”, “campaign_id”, “exclude_deleted”, “offer_id”, “offer_landing_page_id”, “variation_id”]

Opção disponível para 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

Filtre por determinados parâmetros.

Filtro: country_iso

Propriedade

country_iso

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

-

Valores disponíveis

Veja a propriedade iso3 do endpoint /collections/countries

Descrição

Lista de códigos ISO 3

Exemplo:

Filtro date_from, date_to

O date_from e date_to os parâmetros controlam a janela temporal sobre a qual pretende obter informações estatísticas.

  • date_from: data inicial do intervalo para estatísticas (início do mês por defeito),

  • date_to: data final do intervalo para estatísticas (hoje por defeito)

Propriedade

date_from, date_to

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

As datas, por defeito, correspondem ao mês atual.

Valores disponíveis

YYYY-mm-dd

Descrição

Intervalo de datas inicial/final para estatísticas. Formato YYYY-mm-dd

Exemplo:

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 tem efeito.

Filter: advertiser_ad_type_id, campaign_group_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

Propriedade

advertiser_ad_type_id, campaign_group_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

opcional

Tipo de variável

array

Tipo de itens

inteiro

Valor predefinido

-

Valores disponíveis

Propriedades relativas OU coleções

Descrição

Lista de IDs das entidades

Exemplo:

Filtro: exclude_deleted

Propriedade

exclude_deleted

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

0

Valores disponíveis

[0, 1]

Descrição

Se deve excluir campanhas eliminadas ou não.

Exemplo:

Filtro: adblock

Propriedade

adblock

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

"all"

Valores disponíveis

"adblock", "all", "standard"

Descrição

Se deve incluir zonas de adblock ou não.

Exemplo:

Filtro: site_hostname

Propriedade

site_hostname

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

-

Valores disponíveis

Os caracteres válidos para hostnames são letras de a a z, os dígitos de 0 a 9, hífen e ponto.

Descrição

Filtrar pelo hostname do site.

Exemplo:

Filtro: size

Propriedade

size

Tipo

opcional

Tipo de variável

cadeia de caracteres

Valor predefinido

-

Valores disponíveis

Os caracteres válidos para size são os dígitos de 0 a 9 e o caractere x. Exemplo 300x100

Descrição

Filtrar por tamanho

Exemplo:

Parâmetro group_by

Propriedade

group_by

Tipo

obrigatório

Tipo de variável

array

Tipo de itens

cadeia de caracteres

Valor predefinido

-

Valores disponíveis para anunciantes

[”adblock”, “advertiser_ad_type_id”, browser_id”, “idcampaign_group“, “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”, “device_id”, “date”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]

Descrição

Uma lista de subpedidos para incluir dados adicionais na resposta.

Exemplo:

Parâmetro order_by

Propriedade
order_by

Tipo

opcional

Tipo de variável

array

Tipo de itens

cadeia de caracteres

Valor predefinido

-

Valores disponíveis dos campos de métricas

[“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 ordenação disponíveis

[“asc”, “desc”]

Descrição

Uma lista das opções de order by disponíveis

Dicas:

  • Os campos de métricas estão sempre disponíveis para serem usados 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” e “ecpa1” só estão disponíveis quando o utilizador tem Conversion Tracking (Goals). Todos os goals associados a um número de série (g1, g2, …gx). Os valores de eCPA são, respetivamente, ecpa1, ecpa2, …ecpax.

Exemplo:

Exemplo para organizar os resultados da campanha cronologicamente; a “date” precisa de ser incluída tanto em “group_by” como em “order_by”:

Parâmetro projection

O parâmetro projection reflete o que será devolvido no payload resultante. Se não for especificado, todas as subestruturas serão devolvidas.

Propriedade
projection

Tipo

opcional

Tipo de variável

objeto

Tipo de itens

array

Valor predefinido

todas as opções, veja abaixo

Valores de campo disponíveis para anunciantes

[“base”, “rtb”, “video”, “goals*”]

Valores de campo disponíveis para editores

[“base”, “rtb”, “video”, “wpn”]

*Alguns campos "goal", como "profit" e "roi", são calculados com base no custo da campanha, por isso também deve usar o campo "base" se quiser receber as métricas "goals" corretas.

Exemplos:

Para receber todas as métricas possíveis como anunciante, use:

Para receber todas as métricas possíveis como editor, use:

Também pode especificar as métricas dentro de cada campo de projeção:

O único campo que não permite projeção específica de métricas é "goals"

Parâmetro limit

O número de registos a devolver nesta resposta.

Propriedade

limit

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

50

Exemplo:

Parâmetro offset

A posição a partir da qual recuperar os registos.

Propriedade

offset

Tipo

opcional

Tipo de variável

inteiro

Valor predefinido

0

Exemplo

Exemplo 1

Estatística da campanha do anunciante com filtragem.

Pedido:

Resposta:

Exemplo 2

Estatística do anunciante por data para o mês atual, ordenada por impressões.

Pedido:

Resposta:

Exemplo 3

Estatística do publicador por date e region_id, ordenada por impressões.

Pedido:

Resposta:

Exemplo 4

Estatística do publicador por site_id com projeção.

Pedido:

Resposta

Última atualização

Isto foi útil?