Analytics API: Live Métrica

Introducción

Métricas de reproducción para Live corrientes servidas por el Brightcove Live los servicios están disponibles en tiempo real, a través de API de analítica. Estos datos se capturan para transmisiones en vivo solamente; La reproducción de VOD no está incluida.

La API proporciona Live transmitir métricas 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 Live puntos finales Las consultas pueden solicitar múltiples métricas.

Métricos	Descripción
`alive_ss_ad_start`	Impresiones de anuncios del lado del servidor
`ccu`	Unique sesiones; cuenta de distinto (huella dactilar + Sesión)
`fingerprint_count`	Unique dispositivos; cuenta de distinto huellas dactilares (vea abajo)
`video_impression`	Número de veces que se cargó el video player
`video_seconds_viewed`	Segundos totales vistos por todos los espectadores
`video_view`	Se inicia la transmisión (no es única)

Para la ú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í mismo; esto reduce la precisión, pero nos mantiene con la privacidad.

Dimensiones

Las siguientes combinaciones son compatibles como dimensions y where claves de filtrado:

video
video, country
video, device_type

Parámetros de consulta

Otro Live Los puntos finales 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	-	Consultar dimensiones (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	0	Rango de tiempo comienza
a	`<epoch>`	N	ahora	Fin del rango de tiempo

Series de tiempo

La /v1/timeseries el 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 1 minutos cubos por defecto, pero se pueden cambiar a través de un parámetro.

En este contexto, las 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 transmisión.

URI

/v1/timeseries/accounts/$account

Parámetros adicionales

Parámetro	Sintaxis	Requerido	Predeterminado	Descripción
bucket_duration	`<n>m` (minutos) `<n>h` (horas) `<n>d` (dias)	N	1m	Duración representada por cada punto. `1d` es de 24 horas, no es un día calendario.
límite_cubeta	`<n>`	N	-	Número de puntos a devolver. Utilizar cualquiera `bucket_duration` or `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 el punto final devuelve totales métricos para todo o parte de un Live Video en directo.

En este contexto, las métricas únicas (ccu, fingerprint_count) representa el valor total sobre el rango de consulta. Entonces, por ejemplo, una consulta sin from/to los 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

ninguna

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/videos/$video/export?format=xlsx

La respuesta es un XLSX archivo con Live métricas 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 5555y asumir una hora actual de 12:00:00 PM UTC on Feb 15th, 2020.

Obtenga el recuento actual de espectadores (CCU) para un Live Stream o canal

Juego de al menos hace 2 minutos (11:58 a.m.) y usar el último punto en la respuesta

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

Obtenga puntos de gráfico CCU para un Live transmitir en 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 la CCU máxima por día para un Live canal en los últimos 7 días

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

Obtenga la CCU máxima en cualquier momento durante un Live corriente

/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 Live corrientes

El video 5555 se ha completado; Los números son finales. El video 5556 todavía 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 espectadores y anuncios para un programa de una hora en Live canal<

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

Obtener audiencia por país durante la duración de un Live corriente

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