Error message

User warning: The following module is missing from the file system: fast_404. For information about how to fix this, see the documentation page. in _drupal_trigger_error_with_delayed_logging() (line 1143 of /mnt/www/html/ooyala/docroot/includes/bootstrap.inc).

Cómo exportar los datos con la API de estadísticas v2

Aspectos básicos

La siguiente información lo guiará en los procesos para obtener y guardar los datos de estadísticas v2.

A medida que migramos los clientes de Estadísticas v2 a Ooyala IQ (Estadísticas v3), debe saber lo siguiente:
  • A partir del 1.º de enero de 2014, todos los datos de los clientes serán reprocesados.
  • Podrá continuar accediendo a la antigua API de estadísticas v2 hasta el 31 de marzo de 2016.
Esto significa que si debe acceder a más de 1 año de datos de estadísticas históricos, deberá exportar los datos usando las API v2 mientras sigan activas.

Descripción general: La API de estadísticas v2 de Ooyala

Con la API de estadísticas v2 de Ooyala puede crear fácilmente un informe que le proporcionará los datos de estadísticas. Los resultados estarán en formato JSON. (JSON es un formato liviano intercambiable de datos que es fácil de leer y de escribir.)

Para obtener resultados de estadísticas para un rango de fechas específico solo debe definir el tipo de resultado que necesita con la invocación de API /v2/analytics/reports/, ya sea en un emulador de terminal como una terminal en una Mac o en el bloc de notas de Ooyala.

¿Qué es una API?

En programación de computadoras. API (Interfaz de programación de aplicaciones) es el nombre de un conjunto de rutinas y protocolos para aplicaciones de software. Una API expresa un componente de software en términos de sus operaciones y resultados.

¿Dónde puedo encontrar las credenciales de API?

Puede encontrar la clave y el secreto de API en la interfaz de usuario de Backlot. Use las credenciales de API v2 ubicada en Backlot, en la pestaña CUENTA>Desarrolladores.
Figure 1. Encontrar las claves de API
Ubicar las claves de API

¿Cómo funciona la API?

Una invocación a la API de Ooyala requiere de 4 elementos básicos: clave de API, secreto de API, una firma y una hora de vencimiento.

Las invocaciones a la API se hacen con métodos HTTP. La invocación a la API con GET se usa para obtener datos sin modificarlos directamente y le permite recibir como una respuesta un documento con formato JSON según el id del objeto.

¿Cuáles son los resultados disponibles que puedo obtener con la API de estadísticas v2 de Ooyala?

En la API de estadísticas v2 existen 4 calificadores clave que debe especificar para obtener resultados:

asset_id: este valor se consulta con diferentes nombres según dónde lo busque. En la API de Backlot, asset_id es el identificador para un activo específico. asset_id tiene el mismo valor que el ID de contenido que se encuentra en la interfaz de usuario de Backlot que representa una pieza de contenido. El valor es el mismo en todas las situaciones. asset_id puede usarse si desea obtener resultados para un resultado específico. De manera alternativa, puede obtener resultados para su cuenta, que incluyan todos los activos.

date_range: define el rango de fechas para este informe. Las estadísticas se basan en fechas. Puede definir la fecha con el formato (AAAA-MM-DD) o puede definir un rango de fechas con (AAAA-MM-DD...AAAA-MM-DD).

Solicitud de informe: define el tipo de informe que desea obtener. Los valores válidos incluyen el rendimiento, las opciones para compartir, el interés y la entrega.

Dimensión: Las dimensiones son criterios comunes utilizados para acumular datos, como la fecha en que se produjo la actividad del usuario o el país donde se encuentran los usuarios. Además, cada dimensión tiene “desgloses”, que le permiten filtrar los resultados por valores específicos para cada dimensión.

Los parámetros de cadenas de consulta y atributos comunes se pueden encontrar en Atributos comunes y parámetros de cadena de consulta.

Cómo obtener los datos de Estadísticas v2

¿Cuál es el formato de invocación de API?

La API de estadísticas v2 sigue un orden específico en el cuerpo de la API.

Por ejemplo, la invocación de la API: /v2/analytics/reports/account/performance/[:dimension/:drilldown]/:date_range

Debe aparecer como se indica a continuación si desea obtener un informe de rendimiento de 2011-01-01 a 2014-01-01:
Figure 2. Invocación de la API para el informe de rendimiento
Invocación de la API de muestra

¿Cómo puedo usar el bloc de notas para guardar informes?

El bloc de notas es una herramienta creada por Ooyala que le permite realizar consultas a una API en su navegador.

Para obtener un informe de estadísticas con el bloc de notas:
  1. Vaya a https://api.ooyala.com/docs/api_scratchpad?url=.
  2. Seleccione "Su cuenta" en la sección credenciales en la esquina superior derecha de la página.
  3. Escriba las credenciales de la API v2 (clave y secreto de API) en la sección credenciales en la esquina superior derecha de la página.
  4. En el campo Consulta, ubicado en la izquierda de la página, escriba su consulta de estadísticas. Por ejemplo, si desea obtener el informe de rendimiento de 2011 a 2014, copie y pegue esta consulta: /v2/analytics/reports/account/performance/total/2011-01-01...2014-01-01
  5. Seleccione GET.
  6. Haga clic en Enviar.
    Note: Su respuesta aparece en el campo de respuesta.
  7. Si prefiere ver los resultados en una ventana del navegador más grande, copie la URL de la API que se muestra en verde arriba del botón Enviar en su navegador. En este caso, la URL sería https://api.ooyala.com/v2/analytics/reports/account/performance/total/2011-01-01...2014-01-01?api_key=yourApiKey&signature=yourSignature&expires=1418771221.
  8. Guarde el archivo en formato JSON seleccionando Archivo > Guardar como… en su navegador. Para obtener información sobre cómo convertir el formato JSON a CSV, consulte Convertir estadísticas JSON a CSV.

Ejemplos de consulta adicionales

Para obtener más información sobre cómo formular aplicar formato a las consultas en el bloc de notas y para conocer los tipos de informes de estadísticas específicos, consulte lo siguiente:
Note: Para obtener todos los datos de un tipo de informe de su cuenta, use el parámetro de cadena de consulta “total”. Puede encontrar ejemplos del uso de “total” en cada uno de los enlaces de ejemplo de consulta que se mencionaron anteriormente. “total” se usa para obtener todos los datos para un tipo de informe específico para su cuenta.
Por ejemplo, la siguiente consulta obtiene todos los datos de rendimiento para la cuenta en el rango de fechas 2011-08-01...2011-08-02.
[GET]/v2/analytics/reports/account/performance/total/2011-08-01...2011-08-02

¿Cómo puede crear mi propio informe de API?

Solo debería crear su propio script de API si se siente cómodo con la API de Ooyala y creó scripts anteriormente o si tiene recursos técnicos disponibles que pueden modificar la consulta previamente armada para obtener los datos por usted.

Si analiza el siguiente fragmento de código de su código de ejemplo que muestra un terminal, podrá notar que enviamos la solicitud de la invocación de API usando cURL. cURL genera la solicitud HTTP donde puede modificar los parámetros y los encabezados.
Figure 3. Informe de API de muestra
Informe de API
Note: Para conocer más ejemplos de script, consulte la documentación del sitio de soporte en Código de ejemplo para firmar consultas.