Ooyala IQ JSON API - JSON Schema

🔎

Details of the user.

Mandatory attributes of an event. Clients are recommended to buffer events. Buffering duration is based on priority of events - 1 second (high priority), 5 seconds (mid priority) and 10 seconds (low priority).

Player load event

A player instance has fully rendered. This should only be called once per player instance. Priority: High.

Asset display event

Media has been displayed to the user, be it the description or the thumbnail. Priority: High.

Playback has been requested

A playback of media has been requested either via user action or configured autoplay. Priority: High.

Media playback has started

Playback of media has started. Priority: High.

Playback ongoing event

Playback of media is ongoing. Priority: Low

Playthrough completion event

Marks completion of a quartile (25%, 50%, 75% and 100%) of media. This indicates that the user has reached the % completion be it via seek or watching. A playthrough x% requires that all playthrough events < x% has already been generated. Once a playthrough event has been generated, rewinding should not resend it. Priority: High

Percentage watched event

Captures the percentage of the video that the viewer has watched (position independent). The video is divided into 40 buckets. If the viewer watches the first bucket of the video (0-2.5%) and then skips to the last bucket (97.5-100%) and watches it, you should send two percentage watched events [0-2.5%] and [2.5%-5%]. If the viewer watches the same part (bucket) of the video again and again, that viewing event should only be sent once (it’s the player’s responsibility to de-duplicate views of the same part of the video). If you add all the percentage watched for a viewer while they were watching a video, it should always be <= 100%. This metric is per-mille, with the payload being from and to of the bucket. There are 40 buckets total for a video, where each bucket is of size 25 denoting 2.5%. If you see from: 1 and to: 25, that means the viewer has watched bucket number 1. Priority: Medium.

Engagement event

Captures which part of the video the viewer has watched (position dependent). The video is divided into 40 buckets. If the viewer watches the first bucket of the video (0-2.5%) and then skips to the last bucket (97.5-100%) and watches it, you should send two bucket watched events [0-2.5%] and [97.5%-100%]. If the viewer watches the same part (bucket) of the video again and again, that viewing event should be sent each time it is watched (the player should not de-duplicate views of the same part of the video). For example, if a viewer watches the 2.5% - 5% bucket over and over again for 5 times, you should send the event 5 times. This metric is per-mille, with the payload being from and to of the bucket. There are 40 buckets total for a video, where each bucket is of size 25 denoting 2.5%. If you see from: 1 and to: 25, that means the viewer has watched bucket number 1. Priority: Medium

Media Replay Request

Media replay has been requested. Could be user triggered or auto. Priority: High.

Media Seek

Media has been seeked. Priority: Medium

Media Pause

Media has been paused. Priority: Medium

Media Resume

Media has been resumed. Priority: Medium

Time Played

Time played of the media, since the last timePlayedEvent. Priority: Low

Display Device Changed

Media has changed displays, e.g. phone to Chromecast. Priority: High

TBD custom event

Custom event managed and sent by the customer. Keys must be of type String, and values must either be of type String, Integer, Float, or Boolean. Priority: Medium

Provider code of the customer.

Date time in UTC as determined by the client while submitting the ping in the format: YYYY-MM-DDThh:mm:ssZ.

date-time

[Internal field] Date time in UTC as determined by the logger server when request was received in the format: YYYY-MM-DDThh:mm:ssZ.

date-time

[Internal field] The name of the log server that received this ping.

Name of the SDK that generated these analytics events. E.g.: roku_sdk/xbox_sdk

Version of the SDK that generated these analytics events. E.g.: 1.2.0

A session encapsulates a player life cycle, starting from it's creation to it's destruction. Including various media played during it's existence. This field denotes the start of the session in the UTC date format YYYY-MM-DDThh:mm:ssZ.

date-time

Randomly generated Universally unique identifier aka UUID. This is generated randomly by the client per session.

uuid

The url where the user played the asset.

uri

The ip address of the client viewing the asset.

ipv4

Custom metadata managed and sent by the customer.

Details of the user.