API de análisis: Métricas en vivo

Introducción

Métricas de reproducción para transmisiones en vivo proporcionadas por el Brightcove en Directo el servicio están disponibles en tiempo real, a través del API de análisis. Estos datos se capturan para transmisiones en vivo solo; La reproducción de VOD no está incluida.

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

/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étrica

Estas son las métricas disponibles a través de los puntos finales en vivo. Las consultas pueden solicitar múltiples métricas.

Métrico	Descripción
`alive_ss_ad_start`	Impresiones de anuncios del lado del servidor
`ccu`	Único sesiones ; recuento de distintos (huella dactilar + Sesión)
`fingerprint_count`	Único dispositivos ; recuento de distintos huellas dactilares (vea abajo)
`video_impression`	Número de veces que se cargó el video en el reproductor
`video_seconds_viewed`	Total de segundos vistos por todos los espectadores
`video_view`	La transmisión comienza (no es única)

Para único seguimiento, asignamos un huella dactilar a cada dispositivo combinando (Remote IP + User-Agent + Player). Tenga en cuenta que no usamos una identificación de hardware real del dispositivo en sí; esto reduce la precisión, pero nos mantiene en cumplimiento 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 puntos finales Live comparten algunos parámetros comunes que controlan el alcance y la agrupación de la consulta.

Parámetro	Sintaxis	Requerido	Predeterminado	Descripción
dimensiones	`<dim1>,<dim2>,...`	Y	-	Dimensiones de la consulta (GROUP BY)
métrica	`<metric1>,<metric2>,...`	Y	-	Una o más métricas para informar
dónde	`<dim1>==<value1>;...`	Y	-	Uno o más filtros de consulta; debe incluir al menos 1 video
de	`<epoch>`	N	32 días a partir de ahora	Comienzo del rango de tiempo
a	`<epoch>`	N	ahora	Fin del rango de tiempo

Series de tiempo

La /v1/timeseries endpoint devuelve una lista de puntos a lo largo de una línea de tiempo, con el valor de la métrica solicitada en cada momento. Los puntos son 1 minuto cubos de forma predeterminada, pero se puede cambiar mediante un parámetro.

En este contexto, Métricas únicas (ccu , fingerprint_count ) índica el valor máximo en cualquier momento durante cada cubo. Entonces 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_id}

Parámetros adicionales

Parámetro	Sintaxis	Requerido	Predeterminado	Descripción
bucket_duration	`<n>m` (minutos) `<n>h` (horas) `<n>d` (dias)	N	1 m	Duración representada por cada punto. `1d` es de 24 horas, no un día calendario.
bucket_limit	`<n>`	N	-	Número de puntos a devolver. Utilizar cualquiera `bucket_duration` o `bucket_limit` , pero no los dos juntos.

Respuesta

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

Eventos

La /v1/events endpoint devuelve totales de métricas para todo o parte de una transmisión de video en vivo.

En este contexto, Métricas únicas (ccu , fingerprint_count ) representan el valor total sobre 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_id}

Parámetros adicionales

ninguno

Respuesta

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

Exportar

El punto final de Eventos también proporciona un informe descargable:

/v1/events/accounts/{account_id}/videos/{video_id}/export?format=xlsx

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

Resumen
Usuarios concurrentes
Vistas por tipo de dispositivo
Vistas por geografía

Ejemplos de uso

Para todos estos ejemplos, usaremos Cuenta 1234 , vídeo 5555 , y suponga una hora actual de 12:00:00 p. m. UTC en 15 de febrero de 2020.

Obtenga el recuento de espectadores actual (CCU) para una transmisión en vivo o un canal

Colocar de hasta hace al menos 2 minutos (11:58 a.m.) y use la última punto en la respuesta

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

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

Acercar (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 el máximo de CCU 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

Obtenga la CCU máxima en cualquier momento durante una transmisión en vivo

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

Obtenga el total de espectadores únicos y segundos vistos para múltiples transmisiones en vivo

Se completó el video 5555; los números son definitivos. El video 5556 aún está activo; los números son totales acumulados.

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

Obtenga los totales de audiencia y anuncios de un programa de una hora en un canal en vivo <

Programa transmitido de 10:00 a. m. a 11:00 a. m. (UTC)

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

Obtenga audiencia por país durante la duración de una transmisión en vivo

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