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

Dimensiones y campos

Las dimensiones son los depósitos de datos principales para el análisis. Para ver 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. También puede hacer clic en el Hacer una solicitud para hacer una solicitud de muestra y ver los resultados. Si selecciona varias dimensiones incompatibles, verá un mensaje a tal efecto.

  Response will appear here...

Notas

1. Por defecto, video_view es el único campo devuelto; los demás campos se devolverán solo si se especifican en el valor de la fields parámetro.
2. Si especifica un campo para devolver que no es compatible con la dimensión o combinación de dimensiones, un UNSUPPORTED_FIELD_COMBINATION_ERROR se devolverá el error.
3. La bytes_delivered El campo incluye todos los datos entregados por Video Cloud a los clientes, incluidos los datos de video, imágenes, pistas de texto y otros activos, así como el código del reproductor en sí. Algunos de estos datos se obtienen de CDN y es posible que no estén disponibles hasta por 3 días.
4. Además de los campos que se muestran para el video dimensión, también puede devolver 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 dispositivos de escritorio y dispositivos móviles, y también desea saber cuántas de las vistas de dispositivos móviles se realizaron en dispositivos iOS en comparación con dispositivos Android, y cuántas de los dispositivos de escritorio las vistas estaban en Macs frente a máquinas con Windows. Actualmente no hay un informe estándar en el módulo de análisis de Studio que proporcione 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, estamos solicitando visualizaciones de video para el período comprendido entre el 1 de enero y el 1 de abril de 2014).

Ejemplo usando cURL

Si desea probar la API utilizando rizo , 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á escribirlo entre comillas (sencillas o dobles)

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 reemplaza $ACCESS_TOKEN con un token de acceso válido, y {account_id} con su identificación 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 siguiente tabla muestra combinaciones de dimensiones que son compatibles o no. Tenga en cuenta que hay algunos casos en los que se pueden utilizar más de dos dimensiones. Puedes resolverlos usando el Dimensiones y campos herramienta de arriba.

Parámetros de URL

Los informes de la API de Analytics admiten los siguientes parámetros de URL.

Cuentas

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

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

Donde filtros

La sintaxis general de 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ógicos y los puntos y comas como AND lógicos. Por ejemplo, where=video==1234,5678;player==9876 se interpreta como "donde video = 1234 O 5678 Y jugador = 9876 "

Espacios y personajes especiales

Los valores de cadena deben estar codificados en URI. También puede escapar de los caracteres especiales usando un "":

where=search_terms==boston,%20ma

Puede utilizar cualquier dimensión como filtro, pero solo si esa dimensión también se incluye en el dimensions estás 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
• reference_id
• Campos Personalizados ^[1]
• {a_specific_custom_field}
• created_at

Notas

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

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

Ejemplos

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

Etiqueta única

where=video.q==tags:foo

Varias 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

Tenga en cuenta que el video.q la función de búsqueda incluye AND , OR y NOT lógica de la siguiente manera:

• A + El signo (más) antes del término de búsqueda significa resultados deber incluir este término.
• A - El signo (menos) antes del término de búsqueda significa resultados no debe incluir este término.
• Si no hay un signo más o menos, los resultados pueden incluir o no este término.

Los siguientes ejemplos ilustran el uso de esta lógica.

Para obtener una explicación completa de esta sintaxis de consulta, consulte Usando la API de CMS: Buscar videos.

Resumen de filtros y valores permitidos

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

Intervalos de fechas

Intervalos 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 fechas expresadas en este formato:
  • Se interpretará cualquier intervalo de fechas especificado en la zona horaria establecida para la cuenta
  • La hora de la fecha indicada se interpretará como medianoche ( 00:00:00 ) en la fecha especificada en la zona horaria establecida para la cuenta
• Fechas relativas: puede expresar cualquiera de las to y from valores relativos al otro en d (días) oh (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 "desde" (el otro valor)

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

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

Límite y compensación

La limit es el número de artículos a devolver (predeterminado: 10). Para devolver todos los artículos, utilice limit=all . offset es el número de elementos a omitir (predeterminado: 0). Puedes usar limit y offset juntos para crear una aplicación que recorra los resultados.

Datos conciliados

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

Informes geográficos

Dimensiones de la analítica geográfica

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

Nota: Para países o regiones desconocidos, la API devuelve "ZZ" como código (según ISO-3611-alpha2).

Campos y clasificación

Utilizar el 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 está informando (p. ej. destination_domain ) son devueltos. Ver dimensiones y campos para más detalles.

Utilizar el sort parámetro para especificar qué campo de métrica se utiliza para ordenar los elementos devueltos; por ejemplo: sort=video_view. Puede invertir el orden de clasificación negando el campo de clasificación: sort= -video_view.

Campos calculados

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

fields=calulated_field_name:expression

Puede utilizar 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 del campo calculado puede ser cualquier cadena compatible con URI. La expresión puede incluir nombres de campo regulares y los siguientes operadores aritméticos:

• + (suma)
• - (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
  }
}