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

    Descripción general: dimensiones, campos y parámetros

    Las dimensiones son las categorías de datos clave para Analytics API informes de datos. Este tema proporciona una guía interactiva de las dimensiones y los campos que se pueden devolver para ellos. También muestra qué dimensiones se pueden combinar en un informe y los campos disponibles para las diferentes combinaciones.

    Dimensiones y campos

    Las dimensiones son los depósitos primarios de datos para análisis. Para ver las guías completas de las dimensiones individuales, haga clic en el nombre de la dimensión en la lista a continuación.

    Seleccione la (s) dimensión (es) a continuación para ver los campos que se pueden devolver para él. También puede hacer clic en Hacer una solicitud para hacer una solicitud de muestra y ver los resultados. Si selecciona múltiples dimensiones incompatibles, verá un mensaje a tal efecto.

    Entrada

    Seleccione Dimensiones para informar:

    Campos a devolver:

    (utiliza una cuenta de Brightcove de muestra)

    Salida

    Primeras from fecha para esta combinación de dimensiones:  

    Solicitud de API de muestra:

    Datos de respuesta

      Response will appear here...

    Notas

    1. De forma predeterminada, video_view es el único campo devuelto; otros campos serán devueltos solo si están especificados en el valor del fields parámetro.
    2. Si especifica un campo para devolver que no es compatible con la combinación de dimensión o dimensión, una UNSUPPORTED_FIELD_COMBINATION_ERROR error será devuelto
    3. La bytes_delivered campo incluye todos los datos entregados por Video Cloud a clientes, incluidos datos de video, imágenes, pistas de texto y otros activos, así como player código en sí mismo. Algunos de estos datos se obtienen de CDN y pueden no estar disponibles por hasta 3 días.
    4. Además de los campos mostrados para el video dimensión, también puede volver video.custom_fields.{field_name}

    Solicitud de ejemplo

    Un caso de uso típico para obtener un informe en múltiples dimensiones: desea un desglose de las vistas de video entre computadoras de escritorio y dispositivos móviles, y también desea saber cuántas de las vistas de los dispositivos móviles estaban en iOS versus dispositivos Android, y cuántos de los de escritorio las vistas se encontraban en máquinas Mac frente a Windows. Actualmente no hay un informe estándar en el Módulo Studio Analytics que proporciona esta información, pero puede obtenerlo a través de este Analytics API llamada:

      https://analytics.api.brightcove.com/v1/data?accounts=57838016001&dimensions=video,device_type,device_os&from=2014-01-01&to=2014-04-01&fields=video_view

    (En este caso, solicitamos vistas de video para el período comprendido entre enero 1 y abril 1 en 2014).

    Ejemplo usando cURL

    Si quieres probar la API usando cURL, aquí hay un par de notas:

    • Primero necesitará obtener un Token de acceso
    • Dado que la URL de la solicitud siempre incluirá Parámetros de URL, deberá encerrarlo entre comillas (simple o doble)

    Muestra

    Aquí hay un comando cURL de muestra:

      curl -s --header "Authorization: Bearer $ACCESS_TOKEN" \
      "https://analytics.api.brightcove.com/v1/data?accounts=$ACCOUNT_ID&dimensions=video&from=2017-04-04&limit=100"

    Si reemplazas $ACCESS_TOKEN con un token de acceso válido, y $ACCOUNT_ID Con tu ID de cuenta, esta solicitud debería funcionar. Tenga en cuenta que puede utilizar esta aplicación de muestra para generar un token de acceso.

    Combinaciones de dimensiones admitidas

    Para una referencia rápida, la tabla a continuación muestra combinaciones de dimensiones compatibles o no. Tenga en cuenta que hay algunos casos en los que se pueden usar más de dos dimensiones. Puedes resolverlos usando el Dimensiones y campos herramienta arriba.

    Combinaciones de dimensiones admitidas
    account browser_type city country date date_hour destination_domain destination_path device_os device_manufacturer device_type live_stream player referrer_domain region search_terms social_platform source_type video
    account n / a Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí
    browser_type Sí n / a Sí Sí
    city Sí n / a Sí Sí Sí Sí
    country Sí Sí n / a Sí Sí Sí Sí Sí Sí
    date Sí Sí Sí Sí n / a Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí
    date_hour Sí Sí Sí Sí n / a Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí
    destination_domain Sí Sí Sí n / a Sí Sí
    destination_path Sí Sí Sí n / a
    device_os Sí Sí Sí Sí n / a Sí Sí Sí
    device_manufacturer Sí Sí Sí n / a
    device_type Sí Sí Sí Sí n / a Sí Sí Sí
    live_stream Sí Sí n / a
    player Sí Sí Sí Sí Sí Sí Sí n / a Sí Sí Sí
    referrer_domain Sí Sí Sí Sí n / a Sí Sí Sí
    region Sí Sí Sí Sí Sí Sí Sí n / a
    search_terms Sí Sí Sí Sí n / a Sí
    social_platform Sí Sí n / a Sí
    source_type Sí Sí Sí Sí Sí Sí n / a Sí
    video Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí Sí n / a

    parámetros

    A continuación se muestra una tabla que resume los parámetros disponibles en el Analytics API. El uso de los parámetros se analiza con más detalle en las secciones que siguen.

    Parámetro Requerido Descripción Valores Predeterminado

    cuentas

    La Video Cloud Las cuentas para las que desea un informe se especifican mediante la accounts parámetro. Por ejemplo:

      https://analytics.api.brightcove.com/v1/data?accounts={account1_id,account2_id}

    Donde los filtros

    La sintaxis general para los filtros es:

    where=dimension1==value1;dimension2==value2

    Por ejemplo:

    https://analytics.api.brightcove.com/v1?accounts=account_id(s)&dimensions=device_type&where=video==video_id;device_type==tablet

    Las comas se tratan como OR lógicas y los puntos y coma como AND lógicos. Por ejemplo, where=video==1234,5678;player==9876 se interpreta como "donde video = 1234 OR 5678 Y player = 9876 "

    Espacios y personajes especiales

    Los valores de cadena deben estar codificados por URI. También puede escapar caracteres especiales con un "":

    where=search_terms==boston,%20ma

    Puede usar cualquier dimensión como filtro, , pero -unicamente- Si esa dimensión también se incluye en el dimensions usted está solicitando

    Filtrado por propiedades de video

    Usando el especial where=video.q=={property}:{value} filtro, puede limitar su informe a un conjunto específico de videos en función de una variedad de propiedades, que incluyen:

    • etiquetas
    • Identificación de referencia
    • custom_fields []
    • {a_specific_custom_field}
    • Creado en

    Notas

    [] La sintaxis básica es where=video.q==custom_fields:value (coincide con el valor en cualquier campo personalizado) o where=video.q==myfield:value (coincide con el valor en el campo personalizado específico myfield) Si está buscando campos personalizados específicos, tenga en cuenta que debe buscar en Nombre interno, no el nombre para mostrar:

    Nombre interno vs nombre de visualización
    Nombre interno vs nombre de visualización

    Una comprobación rápida de si está usando el nombre correcto: el nombre interno será todo en minúsculas y no contiene espacios.

    Ejemplos

    Aquí hay algunos ejemplos where filtros para buscar en etiquetas y campos personalizados:

    Etiqueta única
    where=video.q==tags:foo
    Múltiples etiquetas:
    where=video.q==tags:foo,bar
    Campos Personalizados
    where=video.q==custom_fields:foo
    Etiquetas y campos personalizados
    where=video.q==tags:foo,bar+custom_fields:fish

    Para una explicación completa de esta sintaxis de consulta, ver Usando el patrón de velas del CMS API: Buscar videos.

    Resumen de filtros y valores permitidos

    La siguiente tabla muestra los valores permitidos para cada dimensión utilizada como filtro:

    Filtro de dimensión Valores permitidos

    Rangos de fechas

    Rangos de fechas, especificados en from y to parámetros para todo tipo de informes, se pueden indicar en diferentes formatos:

    • Valores de texto:
      • to=now (disponible y el valor predeterminado para todas las solicitudes)
    • Valores de tiempo de época en milisegundos, como 1377047323000
    • Fechas expresadas en formato de fecha internacional estándar ISO 8601: YYYY-MM-DDformato, como 2013-09-12. Para las fechas expresadas en este formato:
      • Cualquier rango de fechas especificado será interpretado en la zona horaria establecida para la cuenta
      • La hora de entrega de la fecha se interpretará como la medianoche ( 00:00:00) en la fecha especificada en la zona horaria establecida para la cuenta
    • Fechas relativas: puede expresar cualquiera de los to y from valores relativos al otro en d (días) o h (horas). Por ejemplo:
      • from=2015-01-01&to=31d
      • from=-48h&to=now
      • from=-2d&to=now (dará los mismos resultados que el ejemplo anterior)
      • from=-365d&to=2014-12-31

      Tenga en cuenta que los números negativos (-2d) se interpretan como "antes" (el otro valor) y los números positivos (48h) se tratan como "de" (el otro valor)

    Para generar un informe sobre alguna dimensión, como "video", para un solo día, configure los valores a y desde a esa fecha:

    ...&dimensions=video&from=2013-11-01&to=2013-11-01

    Límite y compensación

    La limit es la cantidad de elementos a devolver (valor predeterminado: 10). Para devolver todos los artículos, use limit=all. offset es la cantidad de elementos para omitir (valor predeterminado: 0). Puedes usar limit y offset juntos para crear una aplicación que pagina a través de los resultados.

    Datos conciliados

    La reconciled parámetro es un booleano. Si está configurado para true, los resultados se limitarán a datos conciliados. Si false, los resultados se limitarán a datos en tiempo real (por hora no conciliados).

    Informes geográficos

    Dimensiones para el análisis geográfico

    • country - Como el código de país ISO-3611-1. Ej .: 'US'
    • region - Como el código de región ISO-3611-2. Ej .: 'US-WA'
    • city - Nombre de la ciudad. Ej .: Seattle

    Nota: para un país o región desconocidos, la API devuelve "ZZ" como el código (según ISO-3611-alpha2).

    Campos y clasificación

    Utilice la fields parámetro para especificar los campos que desea devolver. Por defecto, video_view se devuelve y el campo correspondiente a la dimensión sobre la que informa (p. ej. destination_domain) son devueltos Ver dimensiones y campos para más detalles.

    Utilice la sort parámetro para especificar qué campo de métrica se usa para ordenar los elementos devueltos; por ejemplo: sort=video_view. Puede revertir el orden de clasificación anulando el campo de clasificación: sort= -video_view

    Campos calculados

    Puede agregar campos calculados a sus solicitudes API usando la sintaxis:

    fields=calulated_field_name:expression

    Puede usar campos calculados para crear sus propios campos personalizados a partir de métricas existentes, o para cambiar el nombre de un campo existente.

    El nombre para el campo calculado puede ser cualquier cadena compatible con URI. La expresión puede incluir nombres de campo regulares y los siguientes operadores aritméticos:

    • + (adición)
    • - (sustracción)
    • * (multiplicación)
    • / (división)
    • ^ (exponente)
    • () (paréntesis)

    Ejemplos

    fields=avg_seconds_viewed:video_seconds_viewed/video_view,video.name
    fields=avg_incomplete_ads:(ad_mode_begin-ad_mode_complete)/video_view,video.name
    fields=Video%20Views:video_view,video.name

    Solicitud de muestra

    Ejemplo de respuesta (a la solicitud anterior)

    {
      "item_count": 110,
      "items": [
        {
          "avg_seconds_viewed": 2152.2519913106444,
          "video.name": "Flamingos",
          "video_seconds_viewed": 2972260,
          "video": "4825279519001",
          "video_view": 1381
        },
        {
          "avg_seconds_viewed": 14.016225448334756,
          "video.name": "Tiger",
          "video_seconds_viewed": 16413,
          "video": "4093643993001",
          "video_view": 1171
        },
        {
          "avg_seconds_viewed": 12.06,
          "video.name": "Zebra",
          "video_seconds_viewed": 9045,
          "video": "3851389913001",
          "video_view": 750
        },
        {
          "avg_seconds_viewed": 23.343065693430656,
          "video.name": "Sea-SeaTurtle",
          "video_seconds_viewed": 15990,
          "video": "1754276205001",
          "video_view": 685
        }
      ],
      "summary": {
        "avg_seconds_viewed": 274.27374399301004,
        "video_seconds_viewed": 3139063,
        "video_view": 11445
      }
    }

    Página actualizada por última vez el 21 jul 2020