API de estadísticas globales
Esta sección describe los parámetros de solicitud y los datos de resultado de la API de estadísticas globales.
Las rutas de la API de estadísticas han sido renombradas:
/statistics/advertiser/...->/statistics/a/.../statistics/publisher/...->/statistics/p/...
La API de Estadísticas Globales solo muestra las consultas RTB omitidas para Date, Sites, Zones, Countries, Regions y Sub IDs.
count
Devuelve solo el total de resultados.
entero
opcional
detallado
Obtén más detalle si es posible.
entero
opcional
zona horaria
Configuración de zona horaria para el filtro 'hour' y 'group_by'
cadena
opcional
totals
Indica si se deben añadir totales a la respuesta o no.
entero
opcional
filter
Filtros para restringir los valores devueltos de una consulta de estadísticas
objeto
opcional
group_by
Una lista de valores group_by que se aplicarán en los datos. Se permiten como máximo cuatro.
matriz
obligatorio
order_by
Ordenación de los resultados por uno o varios campos específicos. Se permiten como máximo dos.
matriz
opcional
projection
Subestructuras individuales que un usuario quiere que se devuelvan en la respuesta.
matriz
opcional
limit
El número de registros a devolver en esta respuesta.
entero
opcional
offset
La posición desde la que recuperar los registros.
entero
opcional
Parámetro count
Propiedad
count
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
0
Valores disponibles
[0, 1]
Descripción
Devuelve solo el total de resultados.
Ejemplo:
Parámetro detailed
Propiedad
detallado
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
0
Valores disponibles
[0, 1]
Descripción
Indica si se devuelve información detallada o no.
Ejemplo:
Parámetro timezone
Configuración de zona horaria para hour filter y group_by.
Propiedad
zona horaria
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
America/New_york
Valores disponibles
Establece el campo de zona horaria de / collections / timezones
Descripción
NOTA: Las zonas horarias solo son relevantes cuando consultamos datos basados en horas; para datos no horarios, esto no tiene efecto.
Ejemplo:
Parámetro totals
Propiedad
totals
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
0
Valores disponibles
[0,1]
Descripción
Indica si se deben añadir totales a la respuesta o no.
Ejemplo:
Parámetro filter
Propiedad
filter
Tipo
opcional
Tipo de variable
objeto
Opción disponible 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”]
Opción disponible 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”]
Descripción
Filtra por ciertos parámetros.
Filtro: country_iso
Propiedad
country_iso
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
-
Valores disponibles
Consulta la propiedad iso3 del endpoint /collections/countries
Descripción
Lista de códigos ISO 3
Ejemplo:
Filtro date_from, date_to
El date_from y date_to Los parámetros controlan el intervalo temporal del que quieres obtener información de estadísticas.
date_from: Fecha inicial del rango para estadísticas, (predeterminado: inicio del mes),
date_to: Fecha final del rango para estadísticas, (predeterminado: hoy)
Propiedad
date_from, date_to
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
Las fechas usan por defecto el mes actual.
Valores disponibles
YYYY-mm-dd
Descripción
Rango de fechas desde/hasta para estadísticas. Formato YYYY-mm-dd
Ejemplo:
Las zonas horarias solo son relevantes cuando consultamos datos basados en horas; para datos no horarios, esto no tiene efecto.
Filtro: 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
Propiedad
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 variable
matriz
Tipo de elementos
entero
Valor predeterminado
-
Valores disponibles
Propiedades relativas O colecciones
Descripción
Lista de IDs de entidad
Ejemplo:
Filtro: exclude_deleted
Propiedad
exclude_deleted
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
0
Valores disponibles
[0, 1]
Descripción
Indica si se deben excluir o no las campañas eliminadas.
Ejemplo:
Filtro: adblock
Propiedad
adblock
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
"all"
Valores disponibles
"adblock", "all", "standard"
Descripción
Indica si se deben incluir o no las zonas adblock.
Ejemplo:
Filtro: site_hostname
Propiedad
site_hostname
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
-
Valores disponibles
Los caracteres válidos para los nombres de host son las letras de la a a la z, los dígitos del 0 al 9, el guion y el punto.
Descripción
Filtra por el nombre de host del sitio.
Ejemplo:
Filtro: size
Propiedad
size
Tipo
opcional
Tipo de variable
cadena
Valor predeterminado
-
Valores disponibles
Los caracteres válidos para size son los dígitos del 0 al 9 y el carácter x. Ejemplo 300x100
Descripción
Filtra por tamaño
Ejemplo:
Parámetro group_by
Propiedad
group_by
Tipo
obligatorio
Tipo de variable
matriz
Tipo de elementos
cadena
Valor predeterminado
-
Valores disponibles 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 disponibles para editores
[“adblock”, “browser_id”, “carrier_id”, “category_id”, “country_iso”, “date”, “device_id”, “device_type_id” , “hour”, “language_id”, “month”, “operating_system_id”, “quarter”, “region_id”, “site_id”, “sub”, “week”, “year”, “zone_id”]
Descripción
Una lista de subsolicitudes para incluir datos adicionales en la respuesta.
Ejemplo:
Parámetro order_by
Tipo
opcional
Tipo de variable
matriz
Tipo de elementos
cadena
Valor predeterminado
-
Valores de campo de métricas disponibles
[“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 disponibles que dependen 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 disponibles que dependen 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 orden disponibles
[“asc”, “desc”]
Descripción
Una lista de opciones disponibles para order_by
Sugerencias:
Los campos de métricas están siempre disponibles para usarse como campo de order_by.
Para ordenar por un valor específico (por ejemplo, por “browser_id”), debes incluirlo en el parámetro “group_by”.
Los valores “g1” y “ecpa1” solo están disponibles cuando el usuario tiene Seguimiento de conversiones (Goals). Todos los objetivos asociados a un número de serie (g1, g2, …gx). Los valores eCPA son, en consecuencia, ecpa1, ecpa2, …ecpax.
Ejemplo:
Para organizar cronológicamente los resultados de la campaña, la “date” debe incluirse tanto en “group_by” como en “order_by”:
Parámetro projection
El parámetro projection refleja lo que se devolverá en el payload resultante. Si no se especifica, se devolverán todas las subestructuras.
Tipo
opcional
Tipo de variable
objeto
Tipo de elementos
matriz
Valor predeterminado
todas las opciones, ver abajo
Valores de campo disponibles para anunciantes
[“base”, “rtb”, “video”, “goals*”]
Valores de campo disponibles para editores
[“base”, “rtb”, “video”, “wpn”]
*Algunos campos "goal", como "profit" y "roi", se calculan en función del coste de la campaña, por lo que también debes usar el campo "base" si quieres recibir las métricas "goals" correctas.
Ejemplos:
Para recibir todas las métricas posibles como anunciante, usa:
Para recibir todas las métricas posibles como editor, usa:
También puedes especificar las métricas dentro de cada campo de projection:
El único campo que no permite una proyección específica de métricas es "goals"
Parámetro limit
El número de registros a devolver en esta respuesta.
Propiedad
limit
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
50
Ejemplo:
Parámetro offset
La posición desde la que recuperar los registros.
Propiedad
offset
Tipo
opcional
Tipo de variable
entero
Valor predeterminado
0
Ejemplo
Ejemplo 1
Estadística de campaña de anunciante con filtrado.
Solicitud:
Respuesta:
Ejemplo 2
Estadística de anunciante por fecha para el mes actual, ordenada por impresiones.
Solicitud:
Respuesta:
Ejemplo 3
Estadística del publicador por fecha y region_id, ordenada por impresiones.
Solicitud:
Respuesta:
Ejemplo 4
Estadística del publicador por site_id con proyección.
Solicitud:
Respuesta
Última actualización
¿Te fue útil?

