Overview

The Ooyala IQ Representational State Transfer (REST) over HTTP Application Programming Interface (API) consists of two parts:
  • A write, or input, component (HTTP POST) for recording playback events (not available for customer use).
  • A read, or output, component (HTTP GET) for reporting, known as the v3 Analytics Reporting API.
These are shown as parts 1 and 3 below, which is from the conceptual overview to Ooyala IQ in the Ooyala IQ User Guide, which you might like to read in its entirety.
  Read/Write More details on this API Description
Part 1 Write: POST   Occurrences of events during playback are the actual metrics on which Ooyala IQ is based.
Part 2     Ooyala IQ, behind the scenes, creates datacubes (computed correlations of the various dimensions ) via data aggregation and summarization.
Part 3 Read: GET v3 Analytics Reporting API

This API can be used for data downloading, for loading into your own reporting systems, or for building your own custom statistical graphics.

Note: For queries with query parameters that would exceed the HTTP GET specification limit of 230 characters, please use a POST request. Some browsers and http clients may support more than 230 characters, but we will not provide official support for queries that violate the HTTP GET specification.

Prerequisites for Using the v3 Analytics Reporting API

You need your Ooyala-issued API key and secret to sign the GET requests. See Setup/Mechanics for the v3 Analytics Reporting API.

v3 Analytics

To retrieve analytics reports from Ooyala IQ, use the v3 Analytics Reporting API, also referred to as the v3 Analytics API and the Ooyala IQ API.

Data Retention

Ooyala will only retain up to 37 months of your data. This is calculated as the current month along with the past 36 months. For example, if today is Jan 29, 2015, you have data from current month up to now (Jan 1, 2015 - Jan 29, 2015) and the past 36 full months (Jan 1, 2012 - Dec 31, 2014). Ooyala will only present and allow queries on the most recent 37 months of valid data for you in UI and API. The rest of your data will be archived. For information on how much historical data will be migrated from v2 Analytics to Ooyala IQ, please see Data Migration (Deprecated).

JSON

The bodies of the Analytics API requests and responses rely on JavaScript Object Notation (JSON). If you are unfamiliar with JSON, there are many resources available for learning about it, starting with http://www.json.org.

FAQ

To learn answers to frequently asked questions about Ooyala IQ, please see Ooyala IQ (Analytics) FAQ.

Was this article helpful?