Get all popout call to actions for a player

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "ctas": [
    {
      "chapter_id": 1024,
      "second": 0,
      "duration": 4,
      "auto_close": true,
      "width": 250,
      "html": "<div class=\"main\">Enjoy the video</div>",
      "id": 8233,
      "created_at": 1374726233,
      "updated_at": 1374835343
    },
    {
      "chapter_id": 1027,
      "second": 145,
      "duration": 16,
      "auto_close": true,
      "width": 300,
      "html": "<div class=\"main\">Checkout my CTA!</div>",
      "id": 7359,
      "created_at": 1374261385,
      "updated_at": 1374261385
    }
  ],
  "summary": {
    "page": 1,
    "per_page": 2,
    "count": 100
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

id
required

Used to uniquely identify a player

Validations:

  • Parameter has to be Integer.

include_defaults
optional

Determines whether regular and default CTAs should both be returned.

Validations:

  • Parameter has to be Boolean.

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.