Migración de la API REST de Analytics a la API de Brightcove Analytics

Introducción

Video Cloud Analytics API es bastante similar a la API REST de Ooyala Analytics.

Tenga en cuenta también que el módulo Analytics de Video Cloud Studio incluye un generador de informes personalizado robusto que, en muchos casos, puede hacer que sea innecesario utilizar la API en absoluto.

Las secciones siguientes corresponden a los diferentes aspectos de las dos API:

Autentificación
Informes
Parámetros
Dimensiones
Filtros
Métricas

Autenticación

La autenticación de las solicitudes de API de Brightcove se gestiona ligeramente diferente a la de las API REST de Ooyala. Consulte Autenticación para solicitudes de API de Brightcove para obtener más información.

Informes

El soltero /reports El punto final para la API REST de Ooyala Analytics corresponde muy de cerca a Brightcove Analytics API /data punto final. La principal diferencia es que la API de Ooyala permite tanto GET y POST , este último utiliza para pasar algunos datos en el cuerpo de la solicitud en lugar de parámetros de URL, lo que permite algunas cadenas de datos más largas.

Parámetros

Los parámetros de las solicitudes son similares para las dos API. Se detallan en la siguiente tabla para mostrarle dónde se encuentran las diferencias.

Parámetros
Parámetro Ooyala	Parámetro de Brightcove	Documentos
ninguno	`accounts` - se incluye como parámetro para todos los informes de varias cuentas	Visión general de dimensiones, campos y parámetros
`report_type`	Ninguno, pero la API de Brightcove ofrece algunos puntos finales adicionales para informes de interacción y análisis en vivo	Visión general: API de análisis
`start_date`	`from` los dos parámetros son similares y ambos aceptan valores en el formulario `YYYY-MM-DD` ; el parámetro Brightcove también acepta fechas de época en milisegundos y fechas relativas como `-3d`	Visión general de dimensiones, campos y parámetros
`end_date`	`to` los dos parámetros son similares y ambos aceptan valores en el formulario `YYYY-MM-DD` ; el parámetro Brightcove también acepta fechas de época en milisegundos y fechas relativas como `-3d`	Visión general de dimensiones, campos y parámetros
`metrics`	`fields` - los dos parámetros son esencialmente idénticos; la API de Brighcove también utiliza `metrics` para solicitudes de Live Analytics; consulte Métricas para obtener información sobre qué métricas están disponibles	Visión general de dimensiones, campos y parámetros
`dimensions`	`dimensions` - los dos parámetros son esencialmente idénticos; la API de Brighcove también utiliza `metrics` para solicitudes de Live Analytics; consulte Dimensiones para obtener información sobre qué dimensiones están disponibles	Visión general de dimensiones, campos y parámetros
`filters`	`where` - aparte del nombre, los dos parámetros son esencialmente idénticos; consulte Filtros a continuación para obtener más información	Visión general de dimensiones, campos y parámetros
`time_segment`	ninguno: la API de Brightcove tiene `date` y `date_hour` dimensiones que brindan una segmentación de tiempo similar y también puntos finales de participación para períodos dentro de los 32 días anteriores, que brindan vistas de cada centésima parte del video	Visión general de dimensiones, campos y parámetros
`sort`	`sort` los parámetros son idénticos excepto que la API de Ooyala permite ordenar en múltiples métricas	Visión general de dimensiones, campos y parámetros
`limit`	`limit` - los parámetros son idénticos excepto por el límite 1000 en el param API de Ooyala	Visión general de dimensiones, campos y parámetros
`page`	`offset` - los parámetros toman diferentes valores pero funcionan de manera similar para la paginación de datasets	Visión general de dimensiones, campos y parámetros
ninguno	`reconciled` : debido a que los datos de análisis provienen de diferentes fuentes en diferentes programaciones, la API de Brightcove coloca los datos analíticos recientes en un depósito «no reconciliado» mientras aún se está actualizando, y los transfiere a un bucket «histórico»; el param le permite elegir entre estos cubos	Visión general de dimensiones, campos y parámetros
ninguno	`bucket_limit` - se aplica solo a solicitudes de Live Analytics; junto con `bucket_duration` , estas funciones de una manera algo similar al `time_segment` param API de Ooyala	Visión general de dimensiones, campos y parámetros
ninguno	`bucket_duration`	Visión general de dimensiones, campos y parámetros

Dimensiones

Las API de Ooyala y Brightcove Analytics agrupan los datos en cubos denominados «dimensiones». Se utilizan de formas similares, pero las API tienen reglas algo diferentes en cuanto a cómo se pueden combinar múltiples dimensiones, y Brightcove tiene un conjunto más amplio de dimensiones. Consulte Combinaciones de dimensiones admitidas para obtener más información sobre la API de Brightcove. En la siguiente tabla se proporciona una comparación detallada.

Dimensiones
Dimensión Ooyala	Dimensión de Brightcove	Documentos
`asset`	`video` - la `video` dimensión Brightcove cubre únicamente los activos VOD; también existe una `live_stream` dimensión	Dimensión de vídeo
`country`	`country` - dimensiones son esencialmente idénticas	Dimensión de país
`region`	`region` - las dimensiones son esencialmente idénticas, excepto que la dimensión de Brightcove incluye estados estadounidenses	Dimensión de región
`dma`	ninguno	n/a
`state`	`region` - la API de Brightcove incluye estados estadounidenses en la `region` dimensión	Dimensión de región
`device_type`	`device_type` - dimensiones son esencialmente idénticas	Dimensión del tipo de dispositivo
`domain`	`destination_domain`	Dimensión de dominio de destino
`url`	`device_os` - esencialmente el mismo	Dimensión del SO de dispositivo
`os`	`destination_domain` - no exactamente lo mismo, pero el equivalente más cercano	Dimensión de dominio de destino
`pcode`	`account`	Dimensión de cuenta
`player_id`	`player`	Dimensión del jugador
ninguno	`browser_type`	Dimensión de tipo de navegador
ninguno	`date`	Dimensión de fecha
ninguno	`date_hour`	Dimensión de fecha y hora
ninguno	`device_manufacturer`	Dimensión del fabricante del dispositivo
ninguno	`referrer_domain`	Dimensión de dominio de referencia
ninguno	`search_terms`	Dimensión de términos de búsqueda
ninguno	`social_platform`	Dimensión de plataforma social
ninguno	`source_type`	Dimensión de tipo de origen

Filtros

Los filtros funcionan prácticamente de forma idéntica en las dos API, especificadas en términos de:

      
        // Ooyala
        filter={dimension1}=={value1};{dimension2}=={value2}
      
        // Brightcove
        where={dimension1}=={value1};{dimension2}=={value2}

Métricas

La metrics (para la API de Brightcove: fields ) devuelta en los informes varía según las dimensiones solicitadas para la API de Brightcove Analytics. Puede utilizar la herramienta incrustada en Dimensiones y campos para ver qué campos se pueden devolver para una dimensión concreta o combinación de dimensiones.

Tenga en cuenta que mientras que la API de Ooyala devuelve todas las métricas si no se especifica ninguna, pero la API de Brightcove devuelve sólo un pequeño conjunto de métricas predeterminadas que varían según la dimensión (combinación) a menos que incluya el fields en la solicitud.

Los campos de Brightcove contienen equivalentes para todas las métricas de Ooyala excepto para:

uniq_plays_requested
uniq_displays
uniq_video_starts

Brightcove también Analytics API puede devolver el número de otras métricas no disponibles en el análisis de Ooyala.