Vionlabs Contextual Ad Breaks API
Vionlabs API for retrieval of the Contextual Ad Breaks results.
Get item Contextual Ad Breaks result status and data
Get Contextual Ad Break for an item in the customer catalog
In: header
Path Parameters
Customer identifier of the asset in the catalog
Query Parameters
Contextual Ad Break results version code
A number of minutes of minimum separation between Ad Breaks
1A number of minutes of maximum separation between Ad Breaks
5A number of first minutes to skip checking for an Ad Break presence
1A number of last minutes to skip checking for an Ad Break presence
1Response Body
curl -X GET "https://loading/results/contextual_adbreak/v2/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": "string",
"type": "movie",
"vionlabs_id": "string",
"version_id": "string",
"context_adbreak": [
{
"timestamp": 0,
"frame_number": 0,
"rank": 1,
"contains_nudity": true,
"contains_profanity": true,
"keyword": {
"home invasion": 0.6720908284187317,
"house": 0.8338738679885864
},
"mood_tag": {
"amusing": 0.7611500024795532,
"suspenseful": 0.5756270885467529
},
"iab_version": "3.0",
"iab_tier": {
"Home Appliances": 0.3063124120235443,
"Home Entertaining": 0.3500327467918396,
"Home Improvement": 0.3170643746852875,
"Home Security": 0.32824498414993286,
"Houses": 0.4657664895057678,
"Smart Home": 0.3314751386642456,
"Special Interest Indie or Art House": 0.3367156684398651
},
"iab_uid": {
"326": 0.3500327467918396,
"665": 0.4657664895057678,
"712": 0.3314751386642456,
"743": 0.32824498414993286,
"788": 0.3367156684398651,
"809": 0.3170643746852875,
"833": 0.3063124120235443
},
"iab_all_versions": {
"2.0": {
"iab_tier": {
"Remodeling & Construction": 0.56,
"Utility/Online Tool": 0.58
},
"iab_uid": {
"276": 0.56,
"1008": 0.58
}
},
"2.2": {
"iab_tier": {
"Remodeling & Construction": 0.56,
"Utility/Online Tool": 0.58
},
"iab_uid": {
"276": 0.56,
"1008": 0.58
}
},
"3.0": {
"iab_tier": {
"Interior Decorating": 0.47,
"Remodeling & Construction": 0.56
},
"iab_uid": {
"276": 0.56,
"283": 0.47
}
}
}
}
]
}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get item Contextual Ad Breaks result status
Get Contextual Ad Break result status for an item in the customer catalog
In: header
Path Parameters
Customer identifier of the asset in the catalog
Query Parameters
Contextual Ad Break results version code
Response Body
curl -X GET "https://loading/results/contextual_adbreak/v2/status/string?version=string"{
"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"
}
]
}Get paginated list of items with Contextual Ad Breaks results statuses and data ordered by creation/update timestamp
Gets paginated list of items with Contextual Ad Breaks results statuses for the customer catalog
In: header
Query Parameters
Specifies start of time window (ISO 8601). If not specified then all results will be returned
Specifies 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
Specifies a positional number of page with results
00 <= valueSpecifies a max number of results per page
5001 <= valueSpecify type of assets
"all""all" | "movie" | "series" | "seasons" | "series_and_episodes" | "seasons_and_episodes" | "series_and_seasons_and_episodes" | "movie_and_series"Specifies result version code
Response Body
curl -X GET "https://loading/results/contextual_adbreak/v2/?from_utcdatetime=2024-03-06T20%3A00%3A00&to_utcdatetime=2024-03-07T20%3A00%3A00&page_num=0&page_size=500&type=all&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"
}
]
}