Ooyala Discovery Queue (Deprecated)

Important: The Queue API is disabled. Contact your Ooyala representative for information about alternative options.

When viewer recommendations are discovered, use the Discovery Queue API to let the viewer add them to the viewer's queue. Videos may only be by the video owner (provider).

User authentication in Discovery Queue is based on Ooyala's Rights Locker. For more information see Rights Locker.

The basic sequence of the Discovery Queue API methods is as follows:
  1. When a viewer wants to add an item to the queue, use [PUT] /v2/discovery/queue/assets/asset_id and arguments.
  2. When you want to display the viewer's queue and its items, use [GET] /v2/discovery/queue to get a list of the assets and then use [GET] /v2/assets to retrieve the details for each individual asset
  3. When a viewer wants to remove an item from the queue, use [DELETE] /v2/discovery/queue/asset_id

Add asset to viewer's queue

This example adds a new asset to the queue for viewer ihqwv9uw1eflbkcqwpou.

[PUT]/v2/discover/queue/viewers/account_id/assets/embedCode
The Backlot API responds similarly to the following:
"added_at":1363617641

List viewer's queue

The following example lists the entire queue belonging to viewer.

[GET]/v2/discover/queue/viewers/account_id

When multiple assets have been added to a queue, the response looks like the following. With this array of asset-ids, use [GET] /v2/assets to retrieve the individual asset details, including metadata.

[  
   "RsYmduMjpNE3RGHOTa6Chm-YoxArCqiw",
   "ZoYmduMjpBbLj3QerkWScewtpPnvmOi2",
   "pxcm9lMzpfyODDtj1LiplPwnxmqm5JdM"
]            

Remove a single asset from viewer's queue

The following example removes an item from viewer ihqwv9uw1eflbkcqwpou's queue.

[DELETE]/v2/discover/queue/viewers/account_id/assets/embedCode

A successful call returns no response body.

Remove all asset from viewer's queue

The following example removes an item from viewer ihqwv9uw1eflbkcqwpou's queue.

[DELETE]/v2/discover/queue/viewers/account_id

A successful call returns no response body.

Note: Try out the code samples using your account credentials in the Ooyala Scratchpad. To launch the Scratchpad, go to Ooyala API Scratchpad. For information about using the Scratchpad, see Practice Making Requests with the Scratchpad.

Was this article helpful?