Ad InsertionList Ad Triggers

List Ad Triggers

Returns the queued ad break triggers belonging to this stream.

curl -X POST "https://api.5centscdn.com/v2/streams/pull/123/adinsertion/triggers" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "scheduleIds": [
    101,
    102
  ],
  "viewTriggered": "0",
  "orderByDate": true
}'
[
  {
    "id": 123,
    "relid": 123,
    "value": 42,
    "triggered": 42
  }
]
POST
/streams/pull/{streamid}/adinsertion/triggers
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: X-API-Key)
X-API-Keystring
Required

API key (sent in header)

path
streamidinteger
Required

Numeric stream ID.

Content-Typestring
Required

The media type of the request body

Options: application/json
scheduleIdsarray

Filter to specific schedule IDs.

viewTriggeredstring

Filter by triggered status: 0 pending, 1 already fired.

Options: 0, 1
orderByDateboolean

Set true to order results by value descending.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. Provide your API key in the header.

Path Parameters

streamidinteger
Required

Numeric stream ID.

Body

application/json
scheduleIdsarray

Filter to specific schedule IDs.

viewTriggeredstring

Filter by triggered status: 0 pending, 1 already fired.

Allowed values:01
orderByDateboolean

Set true to order results by value descending.

Responses

idinteger

Beanstalkd job ID.

relidinteger

Parent schedule ID.

valueinteger

Scheduled fire time as a Unix timestamp.

triggeredinteger

Whether the trigger has already fired.

Allowed values:01