API de Analytics: Métricas en vivo

Introducción

Las métricas de reproducción de las transmisiones en directo servidas por el servicio Brightcove Live están disponibles en tiempo real, a través de la API de Analytics. Estos datos se capturan únicamente para transmisiones en vivo ; la reproducción VOD no está incluida.

La API proporciona métricas de transmisión en vivo a través de 2 endpoints:

• /v1/timeseries
• /v1/events

Ambos consultan el mismo conjunto de datos, pero agregan los resultados de manera diferente. Este documento describe el uso y la sintaxis de cada uno.

Métricas

Estas son las métricas disponibles a través de los endpoints Live. Las consultas pueden solicitar varias métricas.

Para un seguimiento único , asignamos una huella digital a cada dispositivo combinando (Remote IP + User-Agent + Player). Tenga en cuenta que no utilizamos un ID de hardware real desde el propio dispositivo, esto reduce la precisión, pero nos mantiene en conformidad con la privacidad.

Dimensiones

Las siguientes combinaciones se admiten como dimensions y where claves de filtrado:

• video
• video, country
• video, device_type

Parámetros de consulta

Ambos extremos Live comparten algunos parámetros comunes que controlan el ámbito y la agrupación de la consulta.

Series de tiempo

El /v1/timeseries punto final devuelve una lista de puntos a lo largo de una línea de tiempo, con el valor de la métrica solicitada en cada punto en el tiempo. Los puntos son cubos de 1 minuto por defecto, pero se pueden cambiar a través de un parámetro.

En este contexto, las métricas Únicas (ccu, fingerprint_count) indican el valor máximo en cualquier momento durante cada bucket. Por lo tanto, una consulta con bucket_duration=1d devolverá la concurrencia máxima para cada día, mientras que una consulta con bucket_limit=1 devolverá la concurrencia máxima en cualquier punto de la secuencia.

URI

/v1/timeseries/accounts/$account

Parámetros adicionales

Respuesta

{
"<metric1>": {
"data": [
  {
    "dimensions": {
        "account": "<account>",
        "<dim1>": "<key1>",
        ...
        "<dimN>": "<keyN>"
      },
    "points": [
      {
        "timestamp": <bucket1>,
        "value": <value1>
      },
      ...,
      {
        "timestamp": <bucketN>,
        "value": <valueN>
      },
    ]
  }
]
},
"<metric2>": {
...
},
...
}

Eventos

El /v1/events punto final devuelve los totales de métricas de la totalidad o parte de una transmisión de vídeo en vivo.

En este contexto, las métricas únicas (ccu, fingerprint_count) representan el valor total en el rango de consulta. Por ejemplo, una consulta sin from/to parámetros devolverán el número total de único sesiones (ccu) y / o dispositivos (fingerprint_count) para toda la transmisión.

URI

/v1/events/accounts/$account

Parámetros adicionales

ninguno

Respuesta

{
"data": [
{
  "dimensions": {
    "account": "<account>",
    "<dim1>": "<key1>",
    ...
    "<dimN>": "<keyN>"
  },
  "totals": {
    "<metric1>": <value1>,
    ...
    "<metricN>": <valueN>
  }
}
]
}

Exportar

El endpoint Events también proporciona un informe descargable:

/v1/events/accounts/$account/videos/$video/export?format=xlsx

La respuesta es un archivo XLSX con métricas en vivo en 4 hojas:

• Resumen
• Usuarios simultáneos
• Vistas por tipo de dispositivo
• Vistas por geografía

Ejemplos de uso

Para todos estos ejemplos, utilizaremos la Cuenta 1234, Video 5555, y supondremos una hora actual de 12:00:00 PM UTC el 15 de febrero de 2020.

Obtener el recuento de visor actual (CCU) para una transmisión en vivo o canal

Establezca desde hace al menos 2 minutos (11:58 AM), y use el último punto en la respuesta.

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581767880000

Obtener puntos de gráficos de CCU para una transmisión en directo durante las últimas 24 horas

Zoom (puntos de 1 minuto)

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1m

Alejar (puntos de 1 hora)

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581681600000&bucket_duration=1h

Obtenga la CCU máxima por día para un canal en vivo durante los últimos 7 días

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&from=1581206400000&bucket_duration=7d

Obtén la CCU máxima en cualquier momento durante una transmisión en directo

/v1/timeseries/accounts/1234?dimensions=video&metrics=ccu&where=video==5555&bucket_limit=1

Obtener el total de espectadores únicos y segundos visualizados para varias transmisiones en directo

El vídeo 5555 se ha completado; los números son definitivos. El vídeo 5556 sigue activo; los números se están ejecutando totales.

/v1/events/accounts/1234?dimensions=video&metrics=fingerprint_count,video_seconds_viewed&where=video==5555,5556

Obtenga los totales de espectadores y anuncios de un programa de una hora de duración en un canal en vivo <

El programa se emitió desde las 10:00 AM hasta las 11:00 AM (UTC)

/v1/events/accounts/1234?dimensions=video&metrics=alive_ss_ad_start,video_view,fingerprint_count&where=video==5555&from=1581760800000&to=1581764399999

Obtener espectadores por país durante la duración de una transmisión en directo

/v1/events/accounts/1234?dimensions=video,country&metrics=video_view,fingerprint_count&where=video==5555