Error message

User warning: The following module is missing from the file system: fast_404. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1143 of /mnt/www/html/ooyala/docroot/includes/bootstrap.inc).

Parámetros de cadenas de consultas de informes

A continuación se incluyen detalles completos de referencia para todos los parámetros de cadenas de consultas de la API de informes v3 Analytics.

Todos los nombres de parámetros distinguen entre mayúsculas y minúsculas.

Toda la cadena de consulta debe estar codificada con URL.

Sintaxis general del informe GET

La sintaxis básica de la ruta y la cadena de consultas es la siguiente. Para facilitar la lectura, la solicitud de una sola línea se ha dividido en varias líneas.

[GET] /v3/analytics/reports/?
            report_type=type
            &dimensions=dimensions
            &metrics=metrics
            &filters=filter_type=='filter_value'
            &start_date=date
            &end_date=date
            &other_parms
            &api_key=your_api_key
         
  • Los párametrso de cadenas de consulta obligatorios (se muestran en negrita) son report_type, start_date y api_key.
  • Si no se especifican dimensiones, se muestran los valores totales en toda la dimensión.
  • Puede especificar hasta 3 dimensiones al mismo tiempo.
  • Si no se especifican las métricas, se muestran todas.
Note: En este momento el único valor válido para report_type es rendimiento.

Sintaxis general de las consultas largas del informe POST

Para consultas con parámetros de consulta que excedan el límite de 230 caracteres para la especificación GET HTTP, use una solicitud POST. Algunos navegadores y clientes http son compatibles con más de 230 caracteres, pero no brindan compatibilidad oficial para las consultas que no cumplen con la especificación GET HTTP. Para las solicitudes POST, use un objeto JSON en el cuerpo de la solicitud en lugar de parámetros de cadenas de consulta.

[POST] /v3/analytics/reports

{
    "report_type":"type",
    "dimensions":"dimensions",
    "metrics":"metrics",
    "filters":"(filter_type==\"filter_value\")",
    "start_date":"date",
    "end_date":"date",
    "other_parms":"other_param_value",
    "api_key":"your_api_key"
}
         
Parámetro Descripción Obligatorio

report_type

Especifica el tipo de informe.

Valores válidos: performance

Valor predeterminado: Ninguno

Ejemplo: report_type=performance

start_date

La fecha de inicio se especifica como YYYY-MM-DD

El valor de start_date es la zona horaria del proveedor.

Valor predeterminado: Ninguno

Limitaciones: Para un máximo de 2 filtros, puede consultar un rango de fechas de hasta 1 año (366 días). Para un máximo de 3 filtros, puede consultar un rango de fechas de hasta 1 mes (31 días).

Ejemplo: start_date=2014-10-28

end_date

La fecha de finalización se especifica como YYYY-MM-DD

Nota: La fecha de finalización no es inclusiva. Es decir, los datos en la respuesta no incluyen la fecha de finalización.

Valor predeterminado: La fecha de mañana en la zona horaria del proveedor.

Limitaciones: Para un máximo de 2 filtros, puede consultar un rango de fechas de hasta 1 año (366 días). Para un máximo de 3 filtros, puede consultar un rango de fechas de hasta 1 mes (31 días).

Ejemplo: Para obtener datos hasta el fin del 29-10-2014: end_date=2014-10-29

No

metrics

Lista de nombres de métricas separados por coma.

Valor predeterminado: * (todas las métricas).

Valores válidos: Consulte Métricas para obtener más información.

Ejemplo: metrics=plays_requested,displays

No

dimensions

Lista de nombres de dimensiones separados por coma. Los resultados se agrupan según las dimensiones especificadas. Si no se especifican dimensiones, se muestran los valores totales en toda la dimensión.

Valores válidos: Consulte Dimensiones para obtener más información. Puede especificar hasta 3 dimensiones al mismo tiempo.

Valor predeterminado: Ninguno

Ejemplo: dimensions=country,region

No

filters

Restringe el conjunto de resultados según los valores de filtro especificados.
Note: Para un máximo de 2 filtros, puede consultar un rango de fechas de hasta 1 año (366 días). Para un máximo de 3 filtros, puede consultar un rango de fechas de hasta 1 mes (31 días).

Valores válidos: Consulte Filtros para conocer las operaciones booleanas y los nombres de los filtros válidos.

  • El valor de filter_by debe codificarse con URL.
  • El valor del filtro real debe estar encerrado entre comillas simples.

Valor predeterminado: Ninguno

Ejemplos:
  • Filtrar por el país Australia: filters=country=='AU'
  • Filtrar por dispositivos móviles en el país Colombia filters=country==’CO’,device_type==’mobile’

No

time_segment

Especifique el segmento basado en tiempo para los datos de dimensión. Consulte la discusión del comportamiento en Sobre time_segment y la persistencia de datos. Así se clasifican bloques de datos.

Note: Una semana se define de lunes a domingo.
Valores válidos:  
  • month | week | day

Valor predeterminado: Ninguno

Ejemplo: time_segment=day

No

sort

Lista de métricas separadas por coma para clasificar. Para usar varias métricas, la clasificación se da en el orden en que las métricas se colocan en la consulta. Puede usar explícitamente tantas métricas de clasificación como desee (si tiene esa métrica), pero el orden predeterminado tiene un límite de dos métricas.

Valor predeterminado: Clasificar según las primeras dos métricas (si están presentes) en el orden de la consulta. El valor predeterminado para ordenar es el orden descendente. Para realizar un orden ascendente, coloque el carácter + delante de una métrica determinada.

Ejemplos:
  • Reproducciones solicitadas, imágenes e inicios de video en orden descendente: sort=plays_requested,displays,video_starts
  • Inicios de video en orden ascendente: sort=+video_starts
Note:

Le recomendamos que no use la métrica segment_watched or percentage_watched para el orden. Use otras métricas, como plays_requested.

Existen diferentes semánticas de orden para las diferentes métricas. Por ejemplo, segment_watched y percentage_watched usan la cadena (o toda la matriz) para ordenar y no usan un orden numérico. Esto significa que, si usa la métrica segment_watched para ordenar, los resultados no se mostrarán en el orden numérico. Los resultados pueden aparecer con el primer resultado con el conteo de la métrica segment_watched menor al del segundo resultado (por ejemplo, [99,…] , [999,...]).

En contraste, la métrica plays_requested usa un orden numérico que proporciona resultados claros.

No

limit

Limite los registros que se obtienen en la respuesta. Límite máximo: 10 000.

Valor predeterminado: 50

Ejemplo: limit=100

No

page

Entero para la paginación. Comienza con 0.

Valor predeterminado: 0

Ejemplo: Para la segunda página: page=1

No

Sobre time_segment y la persistencia de datos

El rango de tiempo se expande automáticamente al rango mínimo de tiempo para cumplir con la solicitud. Por ejemplo, si especifica una fecha de inicio y una fecha de finalización solo para hoy, pero con un time_segment de week, hará que la fecha de inicio y la fecha de finalización especificadas se expandan para cubrir toda la semana actual (en la zona horaria del proveedor). Cuando no se especifica un time_segment, se muestra el total agregado para las dimensiones especificadas. Cuando no existe time_segment ni ninguna otra dimensión especificada, se muestra el total general para el rango de tiempo.