Deprecated audience requests

Warning: Deprecated requests.
Warning: The Audience REST API is currently on version 0, which means it has not been finalised yet and may still change significantly.
This page provides examples for the following requests:

List audience providers

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

HTTP status: 200 OK

Header: -

Body: list of audience data providers and their corresponding information

[
    {
        "id": "<string>",
        "name": "<string>",
        "urlIdentifier": "<string>",
        "useSessionStore": <boolean>,
        "useCookies": <boolean>,
        "enabled": <boolean>,
        "audienceSegmentValues": [
            {
                "segmentId": "<string>",
                "segmentName": "<string>"
            },
            {
                "segmentId": "<string>",
                "segmentName": "<string>"
            }
        ]
    },
    {
        "id": "<string>",
        "name": "<string>",
        "urlIdentifier": "<string>",
        "useSessionStore": <boolean>,
        "useCookies": <boolean>,
        "enabled": <boolean>,
        "audienceSegmentValues": [
            {
                "segmentId": "<string>",
                "segmentName": "<string>"
            },
            {
                "segmentId": "<string>",
                "segmentName": "<string>"
            }
        ]
    }
]

Example

Request header

GET /v0/audience 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": "8915b4ad-0572-4d88-acf9-7f0813c953b5",
        "name": "Audience",
        "urlIdentifier": "dmpAudience",
        "useSessionStore": false,
        "useCookies": true,
        "enabled": true,
        "audienceSegmentValues": [
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1002",
                "segmentName": "Age"
            },
            {
                "segmentId": "kv1001",
                "segmentName": "Gender"
            },
            {
                "segmentId": "kv1001",
                "segmentName": "Gender"
            }
        ]
    },
    {
        "id": "49de123e-0ebd-4aab-890d-de6aba6ca593",
        "name": "Lotame_Data",
        "urlIdentifier": "lotameParam",
        "useSessionStore": false,
        "useCookies": true,
        "enabled": true,
        "audienceSegmentValues": [
            {
                "segmentId": "aff_food",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_lifestyle",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_other",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_other",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_lifestyle",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_other",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_lifestyle",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_bati",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_other",
                "segmentName": "aff"
            },
            {
                "segmentId": "aff_other",
                "segmentName": "aff"
            }
        ]
    }
]

Get audience provider by audience provider ID

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

HTTP status: 200 OK

Header: -

Body: audience provider object

{
    "id": "<string>",
    "name": "<string>",
    "urlIdentifier": "<string>",
    "useSessionStore": <boolean>,
    "useCookies": <boolean>,
    "enabled": <boolean>,
    "audienceSegmentValues": [
        {
           "segmentId": "<string>",
           "segmentName": "<string>"
        },
        {
           "segmentId": "<string>",
           "segmentName": "<string>"
        }
     ]
}

Example

Request header

GET /v0/audience/8915b4ad-0572-4d88-acf9-7f0813c953b5 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": "8915b4ad-0572-4d88-acf9-7f0813c953b5",
    "name": "Audience",
    "urlIdentifier": "dmpAudience",
    "useSessionStore": false,
    "useCookies": true,
    "enabled": true,
    "audienceSegmentValues": [
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1002",
            "segmentName": "Age"
        },
        {
            "segmentId": "kv1001",
            "segmentName": "Gender"
        },
        {
            "segmentId": "kv1001",
            "segmentName": "Gender"
        }
    ]
}