Vionlabs Ad Breaks API
Vionlabs API for retrieval of adbreaks results.
Get Adbreaks Millisec
Get Ad Breaks for an item in the customer catalog (movie or series)
In: query
Path Parameters
Customer identifier for a movie or series item in the catalog
Query Parameters
Ad Breaks version code
A number of minutes to check for an Ad Break presence
50 < valueA number of minutes of minimum separation between Ad Breaks
10 < valueA number of first minutes to skip checking for an Ad Break presence
10 < valueA number of last minutes to skip checking for an Ad Break presence
10 < valueResponse Body
curl -X GET "https://loading/results/adbreaks/v2/filter/millisec/string?version=string&window=5&separation=1&skip_first=1&skip_last=1"{
"inventory_id": "402077_1080p",
"type": "movie",
"vionlabs_id": "33880c61819a5d50",
"version_id": "op-adbreak-v6",
"adbreak": [
{
"rank": 1,
"candidates": [
10.6,
1352.08,
1886.6,
2401.6
]
},
{
"rank": 2,
"candidates": [
1535.4,
2101.3
]
},
{
"rank": 3,
"candidates": [
746.68,
1596.84,
2290.56
]
},
{
"rank": 4,
"candidates": [
865.26,
2550.066
]
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Adbreaks Frame
Get Ad Breaks for an item in the customer catalog (movie or series)
In: query
Path Parameters
Customer identifier for a movie or series item in the catalog
Query Parameters
Ad Breaks version code
A number of minutes to check for an Ad Break presence
50 < valueA number of minutes of minimum separation between Ad Breaks
10 < valueA number of first minutes to skip checking for an Ad Break presence
10 < valueA number of last minutes to skip checking for an Ad Break presence
10 < valueResponse Body
curl -X GET "https://loading/results/adbreaks/v2/filter/frame/string?version=string&window=5&separation=1&skip_first=1&skip_last=1"{
"inventory_id": "402077_1080p",
"type": "movie",
"vionlabs_id": "33880c61819a5d50",
"version_id": "op-adbreak-v6",
"adbreak": [
{
"rank": 1,
"candidates": [
265,
25247,
50837,
60040
]
},
{
"rank": 2,
"candidates": [
38385,
45901
]
},
{
"rank": 3,
"candidates": [
18667,
39921,
57264
]
},
{
"rank": 4,
"candidates": [
7650,
22711
]
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}List Adbreaks
Get paginated list of inventory items with updated Ad Break results ordered by creation/update timestamp.
In: query
Query Parameters
Specifies start of time window (ISO 8601). If not specified then all results will be returned
date-timeSpecifies end of time window (ISO 8601). If not specified then utcnow() value will be used.It is recommended to fix this argument while looping across pages to establish a fixed time window
date-timeSpecifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
10001 <= valueAdbreaks version code
Response Body
curl -X GET "https://loading/results/adbreaks/v2/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=1000&version=string"{
"page_num": 0,
"page_size": 0,
"total_count": 0,
"item": [
{
"inventory_id": "string",
"type": "movie",
"vionlabs_id": "string"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get item Ad Break result status and data, expressed in seconds
Get the ad breaks result status and data in seconds for an item in the customer catalog
In: query
Path Parameters
Customer identifier for a movie or series item in the catalog
Query Parameters
Ad breaks version code
A number of minutes of minimum separation between Ad Breaks
10 < valueA number of minutes of maximum separation between Ad Breaks
50 < valueA number of first minutes to skip checking for an Ad Break presence
10 < valueA number of last minutes to skip checking for an Ad Break presence
10 < valueResponse Body
curl -X GET "https://loading/results/adbreaks/v3/filter/millisec/string?version=string&minimum_separation=1&maximum_separation=5&skip_first=1&skip_last=1"{
"status": "success",
"error": "string",
"updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"inventory_id": "string",
"type": "movie",
"data": {
"inventory_id": "402077_1080p",
"type": "movie",
"vionlabs_id": "33880c61819a5d50",
"version_id": "op-adbreak-v6",
"adbreak": [
{
"rank": 1,
"candidates": [
10.6,
1352.08,
1886.6,
2401.6
]
},
{
"rank": 2,
"candidates": [
1535.4,
2101.3
]
},
{
"rank": 3,
"candidates": [
746.68,
1596.84,
2290.56
]
},
{
"rank": 4,
"candidates": [
865.26,
2550.066
]
}
]
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get item ad break result status and data in frames
Get the ad breaks result status and data in frames for an item in the customer catalog
In: query
Path Parameters
Customer identifier for a movie or series item in the catalog
Query Parameters
Ad breaks version code
A number of minutes of minimum separation between Ad Breaks
10 < valueA number of minutes of maximum separation between Ad Breaks
50 < valueA number of first minutes to skip checking for an Ad Break presence
10 < valueA number of last minutes to skip checking for an Ad Break presence
10 < valueResponse Body
curl -X GET "https://loading/results/adbreaks/v3/filter/frame/string?version=string&minimum_separation=1&maximum_separation=5&skip_first=1&skip_last=1"{
"status": "success",
"error": "string",
"updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"inventory_id": "string",
"type": "movie",
"data": {
"inventory_id": "402077_1080p",
"type": "movie",
"vionlabs_id": "33880c61819a5d50",
"version_id": "op-adbreak-v6",
"adbreak": [
{
"rank": 1,
"candidates": [
265,
25247,
50837,
60040
]
},
{
"rank": 2,
"candidates": [
38385,
45901
]
},
{
"rank": 3,
"candidates": [
18667,
39921,
57264
]
},
{
"rank": 4,
"candidates": [
7650,
22711
]
}
]
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get paginated list of the updated inventory_id items with the ad break results statuses ordered by creation/update timestamp
Get paginated list of inventory items with the updated ad break results ordered by creation/update timestamp.
In: query
Query Parameters
Specifies start of time window (ISO 8601). If not specified then all results will be returned
date-timeSpecifies end of time window (ISO 8601). If not specified then utcnow() value will be used.It is recommended to fix this argument while looping across pages to establish a fixed time window
date-timeSpecifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
5001 <= valueAd breaks version code
Response Body
curl -X GET "https://loading/results/adbreaks/v3/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=500&version=string"{
"page_num": 0,
"page_size": 0,
"total_count": 0,
"data": [
{
"status": "success",
"error": "string",
"updated": "2019-08-24T14:15:22Z",
"version_id": "string",
"inventory_id": "string",
"type": "movie"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}API Specs
All available APIs
Vionlabs Catalog Apis
Vionlabs API for ingest and synchronisation of asset information. The catalog information/data is central to the operation of the system. In order to fully understand the models and the implications of operations it is recommended that developers and integrators consult the relevant section of the Vionlabs developer documentation.