Audience Provider Requests

Audience provider is 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 providers cannot be added through the API. Contact your Account Manager to add a new audience provider for your Pulse account.

The audience provider requests allow you to retrieve audience data provider information.

This page provides examples for the following requests:

List Audience Providers

Method GET
URL https://api.videoplaza.com/v1/audience/provider
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: paginated list of audience providers

{
  "pagination": {
     "totalCount": "<integer>",
     "pageSize": "<integer>",
     "pageNumber": "<integer>",
     "links": {
        "first": "<string>",
        "next": "<string>",
        "previous": "<string>",
        "last": "<string>"
  },
  "providers": [
     {
       "id": "<string>",   (Audience provider ID)
       "name": "<string>",   (Audience provider name)
       "urlIdentifier": "<string>",   (URL parameter for a specific audience provider)
       "enabled": "<boolean>",
       "segmentations": "<string>"   (Link to segmenation list for  a specific audience provider)
       }
     }
   ]
}

Example:

Request header:

GET /v1/audience/provider HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
{
    "pagination": {
        "totalCount": 3,
        "pageSize": 10,
        "pageNumber": 1
    },
    "providers": [
        {
            "id": "7a1de2c0-1bba-4dae-bb5f-564a2c386292",
            "name": "Test",
            "urlIdentifier": "dmpTest",
            "enabled": true,
            "segmentations": "https://api.videoplaza.com/v1/audience/provider/7a1de2c0-1bba-4dae-bb5f-564a2c386292/segmentation"
        },
        {
            "id": "8978549c-d433-4786-be1f-464cca582908",
            "name": "Audience",
            "urlIdentifier": "dmpAudience",
            "enabled": true,
            "segmentations": "https://api.videoplaza.com/v1/audience/provider/8978549c-d433-4786-be1f-464cca582908/segmentation"
        },
        {
            "id": "6c9e795a-76eb-4e4a-a987-de6bcb387fe7",
            "name": "Audience Provider Test",
            "urlIdentifier": "dmpProvider",
            "enabled": false,
            "segmentations": "https://api.videoplaza.com/v1/audience/provider/6c9e795a-76eb-4e4a-a987-de6bcb387fe7/segmentation"
            
        }
    ]
}

Get Audience Provider by Audience Provider ID

Method GET
URL https://api.videoplaza.com/v1/audience/provider/{providerId}
Header Authentication header (x-o-api-key)
Content type application/json
URL params ID of the audience provider, required.
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body: provider object

{
  "id": "<string>",   (Audience provider ID)
  "name": "<string>",   (Audience provider name)
  "urlIdentifier": "<string>",   (URL parameter for a specific audience provider)
  "enabled": "<boolean>",
  "segmentations": "<string>"   (Link to segmenation list for a specific provider)
  }
}

Example:

Request header:

GET /v1/audience/provider/8978549c-d433-4786-be1f-464cca582908 HTTP/1.1
Host: api.videoplaza.com
Content-­type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

Body:
{
    "id": "8978549c-d433-4786-be1f-464cca582908",
    "name": "Audience",
    "urlIdentifier": "dmpAudience",
    "enabled": true,
    "segmentations": "https://api.videoplaza.com/v1/audience/provider/8978549c-d433-4786-be1f-464cca582908/segmentation"
}