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, which enables you to use this API to retrieve and alter
items in the UI, with limitations. 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 Ooyala Pulse available in
the Ooyala Pulse User Guide.

In order to follow the Pulse workflow more accurately, the various Pulse REST API
components are organised into meaningful groups which cover the different workflow
topics. For this reason, the different API components in each group have
different:

base URLs,

communication formats,

Swagger documentation locations (where applicable).

The table below provides a general overview of the different Pulse REST API
groups and their corresponding API components.

The Campaign Management APIs include endpoints for
sucessfully booking a campaign, as well as managing any campaign
and goal targeting rules. Each campaign consists of goals, and
each goal consists of ads, to which you upload assets.

The Forecast API includes endpoints for managing your
campaign and inventory forecasts, as well as the projected
delivery of all active goals. A forecast is a prediction of
future conditions based on past and present data. In this
context, Pulse forecasts future ad inventory based on historical
user traffic, and current campaign and account settings.

Note: The Insight Reporting UI and Insight Reporting REST
API have now been deprecated and Ooyala will no longer provide any support from
30 March 2018. Reports requiring data prior to 1 March 2016 should
be pulled in Insight and stored elsewhere before end of life (30 March 2018). If you
are still using Insight Reporting UI or Insight Reporting REST API, you need to
migrate to Custom Reporting and Custom Reporting API as soon as possible. Contact your
Ooyala representative for details.

The Custom Reporting API offers a powerful tool to pull
complex reports from Ooyala Pulse, within limits. You
can generate reports as you need them, without having
pre-existing report definitions, unlike the Insight
Reporting API.

The Insight Reporting API offers a tool for fast,
reliable access to standard, every day reporting needs.
Pulse pre-aggregates typical combinations of filters,
dimensions, and metrics and makes them available to
report against directly within the Insight UI or through
the Insight API. In the Insight UI, you can also
configure custom templates with some additional
combinations of filters, dimensions, and metrics.

Note: In order to use the Audience API, you first need a data
integration added to your account. Discuss this with your
Account Manager. When created, the providers can be enabled
or disabled.

The Audience API allows you to retrieve
audience data provider information. Audience targeting is a way
to target certain audiences by requesting ads with specific
audience parameters. A very typical case is age and gender,
where age and gender are two different parameters of the same
targeting.

Things Every Developer Should Know

One request at a time: Only one request at a time towards Ooyala Pulse
REST endpoints is allowed for a client.

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.