Ooyala Pulse REST API

Find out how to integrate Ooyala Pulse, leverage its power and export data to external systems. For example, use Ooyala Pulse REST API to integrate with a standalone booking system that handles both display and video campaigns.

Overview

The Ooyala Pulse REST API is organised around the main resources available in the Ooyala Pulse user interface. In order to use it, you need to be familiar with the key concepts, representing the endpoints (campaign, goal, client, targeting rules, campaign/inventory forecast ...), for the Ooyala Pulse platform available in the Ooyala Pulse User Guide.

You need to have an Ooyala Pulse account that you can test the API against and an API key so that you can make API calls. For more information, refer to Authentication.
Attention: We have made major changes in our authentication infrastructure to support the OAuth 2.0 protocol and we strongly recommend clients with existing integrations to upgrade as soon as possible. If you have an existing integration and want to upgrade, please contact your Account Manager for further assistance. For more information on the old way of authenticating, refer to Deprecated: Authenticating Using the X-VP-AUTH-API Key and X-VP-AUTH Token.
Different Pulse API components have different:
  • base URLs,
  • communication formats,
  • documentation locations.
The table belows provides a general overview of the main differences.
Pulse REST API component Base URL Input/Output Format Available Swagger Documentation
Booking API https://api.videoplaza.com/api/1.0 XML No available swagger documentation but you can find examples for all endpoints at Booking REST API Endpoints.
Goal Rules API v2 https://api.videoplaza.com/api/v2 JSON No available swagger documentation but you can find examples for all endpoints at Pulse Goal Rules REST API V2
Ad API https://api.videoplaza.com/v1 JSON https://api.videoplaza.com/v1/swagger
Reporting API https://api.videoplaza.com/api/2.0 JSON https://api.videoplaza.com/docs
Targeting Template API https://api.videoplaza.com/api/2.0 JSON https://api.videoplaza.com/docs
Forecast API https://api.videoplaza.com/api/2.0 JSON https://api.videoplaza.com/docs

Errors

The Ooyala Pulse REST API communicates errors through standard HTTP status codes to indicate the success or failure of an API request. Generally, the following pattern applies:
  • 2xx: Pulse received, understood, and accepted a request.
  • 3xx: The user agent must take further action in order to complete the request.
  • 4xx: An error occurred in handling the request. The most common cause of this error is an invalid parameter.
  • 5xx: Pulse received and accepted the request, but an error occurred in the Pulse service while handling it.

Example Errors

HTTP status:
  403 (Forbidden)

Body:
{
  "type": "ForbiddenError",
  "message": "You have used 5 (100%) of your 5 templates. Please remove obsolete templates in order to create new ones."
}

Things Every Developer Should Know

  1. One request at a time: Only one request at a time towards Ooyala Pulse REST endpoints is allowed for a client.
  2. Updates overwrite data: Update requests replace data with the one sent in this request. If a field is not included, it is cleared in the Ooyala Pulse backend. Best practice is to first retrieve data for an entity, change values in that entity and then send it back in an update.

HTTP Verbs

Verb Description
GET Used for retrieving resources or collections.
POST Used for creating resources.
PUT Used for updating (replacing) complete resources or collections.
PATCH Used for partially updating (modifying) resources using instructions given in the request body.
DELETE Used for deleting resources.

Was this article helpful?