Ad InsertionList Ad Breaks

List Ad Breaks

Custom Plan Returns the logged ad breaks for a date range. Requires the Advanced Analytics add-on.

curl -X GET "https://api.5centscdn.com/v2/zones/vod/pull/42/adinsertion/ad-breaks?r=2026-01-01%2000%3A00%3A00%20-%202026-01-31%2023%3A59%3A59&crid=example_string&session_id=example_string&client_ip=example_string&os=example_string&browser=example_string&content_id=example_string&continent_geoname_id=123&country_geoname_id=123&subdivision1_geoname_id=123&subdivision2_geoname_id=123&city_geoname_id=123&page=1&break_type=pre-roll&trigger_type=example_string&fill_status=full&vast_outcome=ok" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "result": "success",
  "items": [
    {
      "id": "brk_7e21c9",
      "serviceId": 10001,
      "sessionId": "sess_4a1b2c",
      "contentId": "1024",
      "breakType": "pre-roll",
      "triggerType": "preroll",
      "declaredDurationS": 30,
      "vastOutcome": "ok",
      "vastUrl": "https://avails.5centscdn.com/v1/vast?...",
      "creativeCount": 2,
      "fulfilledDurationS": 28,
      "fillStatus": "full",
      "createdAt": "2026-01-15T10:30:00Z"
    }
  ],
  "total": 963,
  "page": 1,
  "limit": 20,
  "pages": 49
}
GET
/zones/vod/pull/{zoneid}/adinsertion/ad-breaks
GET
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)

query
rstring

Date-time range: YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS

query
cridstring

Filter to a specific creative ID.

query
session_idstring

Filter to a specific ad insertion playback session ID.

query
client_ipstring

Filter to a specific viewer client IP. Requires the Advanced Analytics add-on.

query
osstring

Filter to a specific viewer operating system. Requires the Advanced Analytics add-on.

query
browserstring

Filter to a specific viewer browser. Requires the Advanced Analytics add-on.

query
content_idstring

Filter to a specific content ID. Requires the Advanced Analytics add-on.

query
continent_geoname_idinteger

Filter to a specific continent geoname ID. Requires the Advanced Analytics add-on.

query
country_geoname_idinteger

Filter to a specific country geoname ID. Requires the Advanced Analytics add-on.

query
subdivision1_geoname_idinteger

Filter to a specific first-level subdivision geoname ID. Requires the Advanced Analytics add-on.

query
subdivision2_geoname_idinteger

Filter to a specific second-level subdivision geoname ID. Requires the Advanced Analytics add-on.

query
city_geoname_idinteger

Filter to a specific city geoname ID. Requires the Advanced Analytics add-on.

query
break_typestring
Options: pre-roll, mid-roll
query
trigger_typestring

Filter by the trigger type that started the break (e.g. preroll).

query
fill_statusstring
Options: full, underfilled, no_fill
query
vast_outcomestring
Options: ok, timeout, http_4xx, http_5xx, network, parse, no_creative, wrapper_exceeded
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

zoneidinteger
Required

Zone ID

Example:
42

Query Parameters

rstring

Date-time range: YYYY-MM-DD HH:MM:SS - YYYY-MM-DD HH:MM:SS

Example:
2026-01-01 00:00:00 - 2026-01-31 23:59:59
cridstring

Filter to a specific creative ID.

session_idstring

Filter to a specific ad insertion playback session ID.

client_ipstring

Filter to a specific viewer client IP. Requires the Advanced Analytics add-on.

osstring

Filter to a specific viewer operating system. Requires the Advanced Analytics add-on.

browserstring

Filter to a specific viewer browser. Requires the Advanced Analytics add-on.

content_idstring

Filter to a specific content ID. Requires the Advanced Analytics add-on.

continent_geoname_idinteger

Filter to a specific continent geoname ID. Requires the Advanced Analytics add-on.

country_geoname_idinteger

Filter to a specific country geoname ID. Requires the Advanced Analytics add-on.

subdivision1_geoname_idinteger

Filter to a specific first-level subdivision geoname ID. Requires the Advanced Analytics add-on.

subdivision2_geoname_idinteger

Filter to a specific second-level subdivision geoname ID. Requires the Advanced Analytics add-on.

city_geoname_idinteger

Filter to a specific city geoname ID. Requires the Advanced Analytics add-on.

pageinteger
Example:
1
break_typestring
Allowed values:pre-rollmid-roll
trigger_typestring

Filter by the trigger type that started the break (e.g. preroll).

fill_statusstring
Allowed values:fullunderfilledno_fill
vast_outcomestring
Allowed values:oktimeouthttp_4xxhttp_5xxnetworkparseno_creativewrapper_exceeded

Responses

resultstring
Allowed values:successerror
itemsarray
totalinteger
pageinteger
limitinteger
pagesinteger