Audience Management API
If you are using, or want to use, the Pulse Audience Management functionality, the Audience Management API allows you to manage the audience segmentations and audience segments for your audience providers.
In order to use the Pulse Audience Management functionality, you first need a Data Management Platform (DMP) integration added to your account. Please contact your Account Manager if you want to start using Pulse Audience Management. Your Account Manager initiates the integration project in collaboration with our Professional Services team.
- Base URL: https://api.videoplaza.com/v1/audience.
- Requests: GET, POST, and PUT requests are used. You pass parameters by using common REST parameters like PATH, as well as HTTP HEADERS. The body of the requests should be provided in JSON format and encoded using UTF-8.
- Responses: All responses contain an HTTP status code in the header and the body is in JSON format.
- Swagger documentation: Audience Management API
- Related integration documentation: Pulse Audience Management
- Audience Provider Requests
- Audience Segmentation Requests
- Audience Segment Requests
When a DMP integration is added to your Pulse account, Pulse Audience Management allows you to target your viewers using audience data directly through Pulse. Audience targeting is a way to target certain audiences based on different demographic or other criteria. This enables you to sell audience based campaigns and fulfil them in Pulse. A very typical example could be targeting a campaign or goal to Female, 25-30.
Audience targeting is available in the Pulse UI on global, campaign, and goal level, and in targeting templates, just as with any other targeting. It is also available through Pulse APIs. It can be combined with all other targeting rules. For more information, see Targeting Rules and Pulse REST API.
Data Integration Structure
- Audience data provider: a provider of demographic data - Data Management
Platform (DMP). You can have a maximum of three DMP integrations per account
(default setting). When a DMP integration is created, it can be enabled or disabled.
- Audience segmentation: a grouping of related segments, for
example Age, Gender, or Interests. You can have a
maximum of 200 segmentations per DMP integration.
- Audience segment: a specific segment in the audience segmentation, for example 10-14 or 55-65 can be segments of the Age segmentation. You can have a maximum of 15 segments per segmentation.
- Audience segmentation: a grouping of related segments, for example Age, Gender, or Interests. You can have a maximum of 200 segmentations per DMP integration.
The following parameters identify each unique targeting segment, allowing Pulse to
match the information coming from the audience provider with the targeting segments
displayed to a Pulse user.
segmentId are Pulse assigned IDs and cannot be modified.
||Integer||Value between 0-199, Pulse assigned ID for a single segmentation (a grouping of segments).||Previously Index in Segment Identification CSV file.|
||String||Your own segmentation key (ID) sent in the async pixel request, used to parse incoming requests. For example, xyz.||Previously Parameter Name in Segment Identification CSV file.|
||String||Segmentation name displayed in the Pulse UI, for example, Age or Gender.||Previously Key Label in Segment Identification CSV file.|
||Integer||Value between 1-15, Pulse assigned ID for a single segment.||Previously Value in Segment Identification CSV file.|
||String||Your own segment key (ID) sent in the async pixel request, used to parse incoming requests. For example, 123.||Previously Parameter Value in Segment Identification CSV file.|
||String||Segment name displayed in the Pulse UI. For example, Male or Female.||Previously Value Label in Segment Identification CSV file.|
- Initiate the data integration project with INVIDI Professional Services team well before you run your first campaign. It can take anything from a few days to weeks from the point where you realise that you want to work with external data until you can run your first campaign, all depending on your data source. Make sure that you know at what date the data should be accessible in Pulse before you book your first campaign using it.
- Wait for the data to be transferred before you run campaigns. Audience data needs to be transferred to Pulse before you can use it, so wait for a while (the time frame depends on the data source) before you start targeting campaigns to it.
- In Pulse, a viewer can only be matched to a single audience segment within an audience segmentation. This is not a problem, for example, for age and gender, where a viewer can only belong to one age segment and one gender segment. However, you might want to target a viewer based on multiple interests, but this is not supported in Pulse in case all possible interests fall under the same segmentation in your audience definitions.
- Maximum three DMP integrations per account (default setting).
- You cannot add audience providers yourself. Contact your Account Manager to add a new audience provider for your Pulse account.
- Maximum 200 segmentations per integration. For example Age, Gender, or Interests.
- You cannot delete segmentations. Contact Technical Support if you reach the limit and need to have a segmentation deleted.
- Maximum 15 segments per segmentation. For example 10-14 or 55-65 can be segments of the Age segmentation.
- Segments cannot be deleted.
- If using session store:
Note: Inactive users are automatically purged after 13 days. The data is lost from the session store, making the users unavailable for audience management. Campaigns using audience targeting do not deliver to purged users.
- Maximum one async HTTP request per day and per unique user.
- Minimum one update every 13 days per unique user.