Goal VAST URLs Requests

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

You can export the VAST URL for ad calls on a goal when using Pulse for testing purposes or as a 3rd party ad server, meaning you can extract the VAST URL from Pulse and implement it in other ad servers. The provided URL works as a 3rd party call to Pulse and then Pulse functions as a 3rd party redirect.

Getting Started

  • Base URL: https://api.videoplaza.com/v0/goals/{goalId}/vasturl.
  • Requests: GET requests are used. You pass parameters by using common REST parameters like PATH and QUERY, 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: Campaign API v2 - VAST URLs
  • Related user documentation:
Note: Only successful responses are shown in the examples. Details about unsuccessful responses are found in the swagger documentation.

Get VAST URLs by Goal and Category

Method GET
URL https://api.videoplaza.com/v0/goals/{goalId}/vasturl/category/{id}
Header Authentication header (x-o-api-key)
Content type application/json
URL params
  • goalId: the ID of the goal for which you want to export the VAST URLs
  • id: the ID of the category targeted by the ad request
Query params rt (optional): the response ticket format, defaults to VAST_3_0. Possible values:
  • VAST_2_0
  • VAST_2_0_1
  • VAST_3_0
  • VMAP_1_0
Body -
Success response

HTTP status: 200 OK

Header: -

Body:

[
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    },
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    },
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    }
]

Example

Request header:

GET /v0/goals/ffcb4fb2-e1e8-40fa-ade2-b5116056faf3/vasturl/category/f887689f-fc8d-41e1-9396-429f881dcebd 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)

[
    {
        "formatType": "midroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=f887689f-fc8d-41e1-9396-429f881dcebd&tt=m&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "overlay",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=f887689f-fc8d-41e1-9396-429f881dcebd&tt=o&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "pause",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=f887689f-fc8d-41e1-9396-429f881dcebd&tt=pa&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "postroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=f887689f-fc8d-41e1-9396-429f881dcebd&tt=po&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "preroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=f887689f-fc8d-41e1-9396-429f881dcebd&tt=p&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    }
]

Get VAST URLs by Goal and Content Partner

Method GET
URL https://api.videoplaza.com/v0/goals/{goalId}/vasturl/content-partner/{id}
Header Authentication header (x-o-api-key)
Content type application/json
URL params
  • goalId: the ID of the goal for which you want to export the VAST URLs
  • id: the ID of the content partner targeted by the ad request
Query params rt (optional): the response ticket format, defaults to VAST_3_0. Possible values:
  • VAST_2_0
  • VAST_2_0_1
  • VAST_3_0
  • VMAP_1_0
Body -
Success response

HTTP status: 200 OK

Header: -

Body:

[
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    },
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    },
    {
        "formatType": "<string>",
        "vastUrl": "<string>"
    }
]

Example

Request header:

GET /v0/goals/ffcb4fb2-e1e8-40fa-ade2-b5116056faf3/vasturl/content-partner/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)

[
    {
        "formatType": "midroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=64f2ef14-e0ec-4eff-8a4d-b122c712df29&tt=m&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "overlay",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=64f2ef14-e0ec-4eff-8a4d-b122c712df29&tt=o&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "pause",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=64f2ef14-e0ec-4eff-8a4d-b122c712df29&tt=pa&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "postroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=64f2ef14-e0ec-4eff-8a4d-b122c712df29&tt=po&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    },
    {
        "formatType": "preroll",
        "vastUrl": http://hz.videoplaza.tv/proxy/distributor/v2?s=64f2ef14-e0ec-4eff-8a4d-b122c712df29&tt=p&rt=vast_3.0&rnd={random}&xgid=ffcb4fb2-e1e8-40fa-ade2-b5116056faf3"
    }
]

해당 내용이 도움 되었습니까?