soporte Contactar con Soporte | Estadoestado del sistema del sistema
Contenido de la página

    Descripción general: v1Analytics API

    En este tema, obtendrá una descripción general de la API de Analytics.
     

    Introducción

    Analytics API Le permite obtener datos analíticos de sus cuentas de Video Cloud directamente. También puede ver los informes de análisis integrados en el módulo Analytics de Video Cloud Studio. Acceder a los datos mediante programación le proporciona flexibilidad adicional.

    Consulte también la Referencia de API.

    Usos típicos

    Aquí hay algunos usos típicos de la API:

    • Creación de gráficos y pantallas personalizadas
    • Trabajar con varias API juntas, por ejemplo, obtener datos de vídeo utilizando para vídeos con la mayor cantidad de vistas de la semana anteriorCMS API
    • Combinación de sus datos analíticos de vídeo con otros datos analíticos de sitios
    • Para ver algunas soluciones de ejemplo, consulte

    URL base

    La URL base para el Analytics API es:

      <code class="language-http translate="no» > https://analytics.api.brightcove.com/v1

    Encabezados

    Autenticación (obligatorio)

    El Analytics API utiliza el servicio OAuth de Brightcove para autenticar llamadas.

    Primero deberá obtener las credenciales de cliente (a y).client_idclient_secret Se trata de una operación única que se puede realizar mediante la interfaz de usuario de credenciales de OAuth. Puede obtener las credenciales del cliente directamente desde Brightcove OAuth Service utilizando CURL , Postman o Insomnia.

    Necesita permisos de lectura y lectura de vídeo de Analytics para las credenciales de cliente:

    <img class="bcls-image» alt="Permisos para < span Translate="No» Credenciales de API de > Analytics » src=» /assets/images/analytiics/getting-started/analytics-permissions.png "/>
    Permisos para Analytics API credenciales

    Si está creando sus credenciales directamente a través de la API de OAuth, los permisos necesarios son:

      [
        "video-cloud/analytics/read"
        "video-cloud/video/read"
      ]

    También necesitará un, que se obtiene usando el y y se pasa en un encabezado de autorización con su solicitud de API:access_tokenclient_idclient_secret

      Authorization: Bearer {access_token}

    El caduca después de cinco minutos, por lo que debe obtener uno para cada solicitud, o comprobar para asegurarse de que su token sigue siendo válido.access_token Consulte Obtención de tokens de acceso para obtener una explicación detallada de cómo obtener tokens de acceso, incluidos ejemplos de código.

    Accept-Encoding: gzip (optional)

    Pasar este encabezado hará que la respuesta se devuelva en forma comprimida. Esto puede mejorar el rendimiento de informes de gran tamaño.

    Almacenamiento en caché

    Por razones de rendimiento, las respuestas de API se almacenan en caché durante aproximadamente 5 minutos, aunque la cantidad exacta de tiempo puede variar en función de varios factores. Para cualquier Analytics API consulta, puede obtener información sobre la caché de los encabezados de respuesta:

    Encabezados de control de caché
    Encabezados de control de caché

    El Cache-Control le indica el tiempo máximo para el que los resultados se almacenarán en caché en segundos (en el ejemplo anterior, 24 segundos). los Last-Modified y Expires los encabezados le indican cuándo se creó la caché actual y cuándo caducará.

    En la mayoría de los casos, esto probablemente no sea un problema, pero si la frescura de los datos de análisis es de importancia crítica, debe saber que cuanto más se ejecute una consulta, más tiempo se almacenará en caché y los informes que obtienen datos en tiempo real (no reconciliados por hora) solo no se almacenarán en caché mientras aquellos que obtienen datos reconciliados (solo, o además de datos en tiempo real). Encuentre una explicación completa de los datos en tiempo real y reconciliados si lo desea; la versión corta es que el se Analytics API basa en dos depósitos de datos:

    • datos no conciliados en tiempo real o por hora, que se ponen a disposición inmediatamente y se almacenan durante 32 días
    • datos reconciliados, que se almacenan permanentemente; los datos en tiempo real se concilian para mejorar la precisión y se almacenan en el repositorio de datos conciliados cada 24 horas

    Puede limitar los resultados a datos conciliados o en tiempo real mediante el parámetro reconciliado .

    Para minimizar el almacenamiento en caché:

    • Utilice el reconciled=false parámetro para limitar los resultados a datos en tiempo real
    • Utilice un intervalo de fechas pequeño y asegúrese de que todo el rango se encuentra dentro de los últimos 32 días

    Tiempo de espera

    La API de Analytics solicita tiempo de espera después de 8 minutos si no se ha completado. Si ve tiempos de espera a menos de 8 minutos, entonces la causa es algún límite del lado del cliente.

    Máximo de artículos que puedes devolver

    El número máximo de artículos que se pueden devolver es de un millón. En la mayoría de los casos es poco probable que llegue al límite, pero si solicita informes sobre la date dimensión durante un gran lapso de tiempo, por ejemplo, es posible. Si alcanza el límite de millones de artículos, deberá modificar la solicitud para reducir el número de artículos devueltos. Generalmente, la forma más sencilla de hacer esto será reducir el rango de datos (usando el from y to parámetros discutidos más adelante).

    Solicitudes Simultáneas

    Una sola cuenta está limitada a una solicitud a la vez. Múltiples solicitudes simultáneas se ejecutarán en serie.

    Por ejemplo:

    1. Inicie una solicitud de API «A».
    2. Inicie la solicitud de API «B» para la misma cuenta.
    3. La solicitud «B» no se completará hasta que se complete «A».
    4. Si la solicitud «A» tarda demasiado tiempo, la solicitud «A» recibirá un error diciendo «su solicitud está pendiente; inténtelo de nuevo».
    5. Si la solicitud «A» tarda demasiado tiempo, puede hacer que la solicitud «B» reciba el mismo error. Tenga en cuenta que la solicitud «B» obtendrá un error si el tiempo para completar A + B es mayor que nuestro valor de tiempo de espera.

    Si realiza varias solicitudes simultáneas, se procesarán una a la vez, en el pedido recibido.

    Las solicitudes que regresen con un «error pendiente» eventualmente se completarán y se guardarán en nuestro caché. Esto significa que las futuras solicitudes de los mismos datos regresarán casi instantáneamente, pero solo si la solicitud se realiza antes de que caduque la caché de cinco minutos.

    Sus sistemas deben manejar el error pendiente esperando de 2 a 4 minutos y haciendo la misma solicitud de nuevo.

    Mejores prácticas

    Tipos de solicitud

    El Analytics API acepta tres tipos de solicitud

    Datos (también llamado Informe)
    Un informe sobre uno o más dimensions. El extremo de una solicitud de informe es:
      https://analytics.api.brightcove.com/v1/data?accounts={account_id(s)}&dimensions={dimensions}
    Informe de participación
    Datos detallados de contratación disponibles para periodos de los últimos 32 días. Consulte la sección de compromiso para obtener más detalles.
    Punto final de información de vídeo
    Una pieza específica de datos analíticos servidos con una latencia mínima. Consulte Punto final de datos de vídeo para obtener más información.

    Donde se pueden aplicar filtros y intervalos de fechas a los informes. Las solicitudes de informes pueden tener parámetros adicionales detallados en este documento.

    Dimensiones y campos

    La información detallada sobre las dimensiones y los campos se encuentra ahora en un documento separado: Visión general de cotas, campos y parámetros.

    Parámetros

    La información detallada sobre los parámetros se encuentra ahora en un documento separado: Visión general de cotas, campos y parámetros.

    Informes de participación

    Los informes detallados de interacción que muestran las vistas de cada centésima parte de los vídeos (o los promedios de todos los vídeos de una cuenta o reproductor) están disponibles durante periodos de los últimos 32 días. (Las solicitudes de intervalos de fechas fuera de los últimos 32 días devolverán un error.)

    Interacción de cuenta

    Para obtener valores medios de interacción en vídeos visualizados, utilice el punto final:

      
          https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id
      

    Participación del jugador

    Para obtener valores medios de todos los vídeos visualizados en un reproductor, utilice el punto final:

      
          https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/players/:player_id
      

    Participación de espectadores

    Para obtener datos de interacción de un vídeo específico, utilice el endpoint:

      
          https://analytics.api.brightcove.com/v1/engagement/accounts/:account_id/videos/:video_id
      

    Análisis en vivo

    Analytics API Proporciona dos puntos finales para recuperar análisis para transmisiones en vivo de Brightcove, ya sea por serie temporal o por evento. Consulte la Analytics API Reference para obtener más detalles.


    Última actualización de la página el 28-09-2020