Content Partner Requests

Warning: The Content Partner REST API is currently on version 0, which means it has not been finalised yet and may still change significantly.

Content Partners refer to content owned by a third party for revenue sharing deals, hence requiring detailed reporting on any ads served on specific content, no matter which site it was consumed on.

Getting Started

  • Base URL: https://api.videoplaza.com/v0/content-partners.
  • Requests: GET 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: Content Partner API
  • Related user documentation:
Note: Only successful responses are shown in the examples. Details about unsuccessful responses are found in the swagger documentation.

List All Content Partners

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

HTTP status: 200 OK

Header: -

Body:

[
    {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "enabled": "<boolean>",
        "aliases": [
            "<string>",
            "<string>"
        ]
    },
    {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "enabled": "<boolean>",
        "aliases": [
            "<string>",
            "<string>"
        ]
    }
]

Example

Request header:

GET /v0/content-partners 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)

[
    {
        "id": "64f2ef14-e0ec-4eff-8a4d-b122c712df29",
        "name": "Cooking Channel TV",
        "description": "All cooking shows.",
        "enabled": true,
        "aliases": [
            "cooking",
            "cooking*",
            "cooking-show",
            "cooking-show*"
        ]
    },
    {
        "id": "06797808-3c9a-4fb4-916a-43279f2a6b11",
        "name": "Disney",
        "description": "All Disney related items.",
        "enabled": true,
        "aliases": [
            "disney",
            "disney*"
        ]
    },
    {
        "id": "02a7e2c0-09c5-4e45-b69c-c5c6a2292f9f",
        "name": "Food Network",
        "enabled": true
    },
    {
        "id": "9f8b6f3c-be62-4182-b13b-978b717d6916",
        "name": "Fremantle Media",
        "enabled": true
    },
    {
        "id": "4acd2404-3027-4044-8d30-0ff82037e0e7",
        "name": "Unassigned",
        "enabled": true
    }
]

Get Content Partner by Content Partner ID

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

HTTP status: 200 OK

Header: -

Body:

{
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "enabled": "<boolean>",
    "aliases": [
        "<string>",
        "<string>"
    ]
}

Example

Request header:

GET /v0/content-partners/64f2ef14-e0ec-4eff-8a4d-b122c712df29 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)

{
    "id": "64f2ef14-e0ec-4eff-8a4d-b122c712df29",
    "name": "Cooking Channel TV",
    "description": "All cooking shows.",
    "enabled": true,
    "aliases": [
        "cooking*",
        "cooking-show*",
        "cooking-show",
        "cooking"
    ]
}
https://help.ooyala.com/sites/all/libraries/dita/en/video-advertising/oadtech/ad_serving/dg/rest_content_partner_endpoint.html

Was this article helpful?