soporte Contactar con asistencia técnica | estado del sistema Estado del Sistema
Contenido de la página

    Características: Analytics API v1

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

    Introducción

    La Analytics API le permite obtener datos analíticos para su Video Cloud Cuentas directamente. También puede ver los informes de análisis integrados en el Módulo de análisis de Video Cloud Estudio. Acceder a los datos programáticamente le da flexibilidad adicional.

    Ver también el Referencia de la API.

    Los usos típicos

    Estos son algunos usos típicos de la API:

    • Crear diagramas y pantallas personalizados
    • Trabajando con varias API juntas, por ejemplo, obteniendo datos de video usando el CMS API Para los videos con más visitas durante la semana anterior.
    • Combina tus datos analíticos de video con otros datos analíticos del sitio
    • Para algunas soluciones de muestra, ver

    URL base

    La URL base para el Analytics API es:

      https://analytics.api.brightcove.com/v1

    Encabezados

    Autenticacion requerida)

    La Analytics API usa el Brightcove Servicio de OAuth para autenticar llamadas.

    Primero deberá obtener las credenciales del cliente (una client_id y client_secret) Esta es una operación de una sola vez que se puede realizar utilizando el Interfaz de usuario de credenciales de OAuth. Puede obtener credenciales de cliente directamente desde el servicio Brightcove OAuth utilizando RIZO, Carteroo Insomnio.

    Necesita los permisos de lectura de Analytics y lectura de video para las credenciales del cliente:

    Permisos para Analytics API Referencias
    Permisos para Analytics API Referencias

    Si está creando sus credenciales directamente a través del OAuth API, los permisos requeridos son:

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

    También necesitarás un access_token, que se obtiene usando el client_id y client_secret y pasado en un encabezado de Autorización con su solicitud de API:

      Authorization: Bearer {access_token}

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

    Aceptar-Codificación: gzip (opcional)

    Al pasar este encabezado, la respuesta se devolverá en forma comprimida. Esto puede mejorar el rendimiento para informes grandes.

    Almacenamiento en caché

    Por motivos de rendimiento, las respuestas de la API se almacenan en caché durante aproximadamente X minutos XNUM, 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 memoria caché a partir de los encabezados de respuesta:

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

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

    En la mayoría de los casos esto probablemente no es un problema, pero si la frescura de los datos analíticos es de importancia crítica, debe saber que cuanto más tiempo se ejecute una consulta, más tiempo se almacenará en caché e informes que solo obtendrán datos en tiempo real (sin conciliar por hora) no se almacenará en caché, siempre y cuando se obtengan datos reconciliados (solo o además de los datos en tiempo real). Encontrar un explicación completa de datos en tiempo real y reconciliados Si te gusta; la versión corta es que el Analytics API se basa en dos segmentos de datos:

    • en tiempo real, o datos no conciliados por hora, que están disponibles inmediatamente y se almacenan durante días 32
    • datos reconciliados, que se almacena de forma permanente; 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 reconciliados o en tiempo real usando el reconciliado parámetro.

    Para minimizar el almacenamiento en caché:

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

    Tiempos de espera

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

    Cantidad máxima 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 está solicitando informes en el date dimensión en 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. En general, la forma más sencilla de hacerlo será reducir el rango de datos (utilizando el from y to parámetros discutidos más adelante).

    Solicitudes concurrentes

    Una sola cuenta está limitada a una solicitud a la vez. Múltiples solicitudes concurrentes 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 "A" complete.
    4. Si la solicitud "A" tarda demasiado, la solicitud "A" recibirá un mensaje de error que dirá "su solicitud está pendiente, intente de nuevo".
    5. Si la solicitud "A" tarda demasiado, 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 orden en que se recibieron.

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

    Sus sistemas deben manejar el error pendiente esperando los minutos 2-4 y haciendo la misma solicitud nuevamente.

    Mejores prácticas

    Tipos de solicitud

    La Analytics API acepta tres tipos de solicitud

    Datos (también llamado informe)
    Un informe sobre uno o más dimensiones. El punto final para una solicitud de informe es:
      https://analytics.api.brightcove.com/v1/data?accounts={account_id(s)}&dimensions={dimensions}
    Engageinforme de ment
    Datos de participación detallados que están disponibles para períodos dentro de los últimos días de 32. Ver la sección de participación para más detalles.
    Punto final de información de video
    Una pieza específica de datos analíticos servida con latencia mínima. Ver Punto final de datos de video .

    Donde los filtros y rangos de fechas Puede aplicarse a informes. Las solicitudes de informes pueden tener parámetros adicionales detallados en este documento.

    Dimensiones y campos

    La información detallada sobre dimensiones y campos se encuentra ahora en un documento separado: Resumen de dimensiones, campos y parámetros.

    parámetros

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

    Engageinformes de ment

    Informes detallados de participación que muestran las vistas para cada 100a parte de los videos (o los promedios en todos los videos para una cuenta o player) están disponibles por períodos dentro de los últimos 32 días. (Las solicitudes de rangos de fechas fuera de los últimos 32 días devolverán un error).

    Contrato de cuenta

    Para obtener valores promedio de participación en videos vistos, use el punto final:

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

    Player Recoja

    Para obtener valores promedio para todos los videos vistos en un player, use el punto final:

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

    Video de compromiso

    Para obtener datos de participación para un video específico, use el punto final:

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

    Live Analytics

    La Analytics API proporciona dos puntos finales para recuperar análisis para Brightcove Live Streams, ya sea por una serie de tiempo o por evento. Ver el Analytics API Referencia para más detalles.


    Página actualizada por última vez el 12 jun 2020