{"openapi":"3.0.0","info":{"version":"3.0","title":"TargetVideo API","termsOfService":"https://cms.target-video.com/pages/view/terms-conditions","contact":{},"license":{"name":""}},"servers":[{"url":"https://api.target-video.com/apiv3/","variables":{}}],"security":[{"bearer":[]}],"paths":{"/playlist/clear/{playlist_id}.json":{"post":{"summary":"clear","operationId":"PlaylistClear","parameters":[{"$ref":"#/components/parameters/playlist_id"}],"responses":{"200":{"description":"","headers":{}}},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","example":"111","description":"Id of the playlist that should be cleared."}}},"example":[{"key":"id","value":"{{PLAYLIST_ID}}","description":"**[REQUIRED, INT]** Playlist id.","type":"text"}]}}}}}},"components":{"parameters":{"from":{"name":"from","in":"query","required":true,"style":"form","schema":{"type":"string","example":"YYYY-MM-DD"},"description":"Report starting date"},"to":{"name":"to","in":"query","required":true,"style":"form","schema":{"type":"string","example":"YYYY-MM-DD"},"description":"Report ending date"},"detailed":{"name":"detailed","in":"query","required":false,"style":"form","schema":{"type":"integer","example":"1 or 0"},"description":"Optional flag if you want to request detailed data in the report. Acceptable values are 1/0."},"site":{"name":"site","in":"query","required":false,"style":"form","schema":{"type":"string","example":"example.com, example2.com"},"description":"Optional comma separated list of site domains to filter the report by specific sites."},"format":{"name":"format","in":"query","required":false,"style":"form","schema":{"type":"string","example":"format"},"description":"Optional format of the response. Acceptable values are csv (default) or json."},"page":{"name":"page","in":"query","required":false,"style":"form","schema":{"type":"integer"},"description":"Page number."},"playlistPage":{"name":"page","in":"query","required":false,"style":"form","schema":{"type":"integer"},"description":"If playlist contains large list of videos, response will be divided in multiple pages."},"limit":{"name":"limit","in":"query","required":false,"style":"form","schema":{"type":"integer"},"description":"Limit items per page."},"playlistLimit":{"name":"limit","in":"query","required":false,"style":"form","schema":{"type":"integer"},"description":"Limit number of videos in the playlist response."},"partner_id":{"name":"partner_id","in":"path","required":true,"description":"Your websites ID in TargetVideo. See API section in websites settings in the CMS.","schema":{"type":"integer"},"example":"PARTNER_ID"},"video_search_term":{"name":"video_search_term","in":"query","required":true,"style":"form","schema":{"type":"string","example":"video_search_term"},"description":"Your websites ID in TargetVideo. See API section in websites settings in the CMS."},"exchange_rule_id":{"name":"exchange_rule_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"exchange_rule_id"},"description":"Exchange rule id"},"livestream_id":{"name":"livestream_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"LIVESTREAM_ID"},"description":"Livestream ID."},"livestream_schedule_id":{"name":"livestream_schedule_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"123"},"description":"123"},"ls_schedule_status":{"name":"status","in":"query","required":false,"style":"form","schema":{"type":"string","example":"active","description":"Supported values are:

completed
upcoming
active

"}},"includeCarouselVideos":{"name":"includeCarouselVideos","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"boolean","example":"includeCarouselVideos","description":"Include carousel videos in response(excluded by default)."}},"livestreamOnly":{"name":"livestreamOnly","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"boolean","example":"TRUE"}},"excludeNotPublished":{"name":"excludeNotPublished","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"boolean","example":"excludeNotPublished"}},"moreData":{"name":"moreData","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"boolean","example":"moreData"}},"searchTag":{"name":"searchTag","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"string","example":"tag1|tag2 or tag1,tag2"}},"excludeTag":{"name":"excludeTag","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"string","example":"tag1,tag2"}},"tag":{"name":"tag","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"string","example":"tag"}},"tags":{"name":"tags","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"boolean","example":"1"}},"playlistTags":{"name":"Playlist[tags]","in":"query","required":false,"style":"form","schema":{"type":"integer","example":"1","description":"Include playlist tags in the response."}},"searchChannel":{"name":"searchChannel","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"string","example":"Channel name"}},"excludeChannel":{"name":"excludeChannel","in":"query","required":false,"style":"pipeDelimited","schema":{"type":"string","example":"Channel name"}},"PlaylistVideos":{"name":"Playlist[videos]","in":"query","required":false,"style":"form","schema":{"type":"integer","example":""},"description":"Set number of videos in the playlist. (Default 3). Limit is 25"},"adtag_id":{"name":"adtag_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"ADTAG_ID"}},"User-Agent":{"name":"User-Agent","in":"header","required":true,"style":"simple","schema":{"type":"string","example":"Api | BridVideo"}},"channel_id":{"name":"channel_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"CHANNEL_ID"}},"list_type":{"name":"list_type","in":"path","required":true,"style":"simple","schema":{"type":"string","example":"all, list, threaded, count"},"description":"Grab specified list of IAB taxonomies. Possible values are:

all
list
threaded
count

"},"ids":{"name":"ids","in":"query","required":true,"style":"form","schema":{"type":"number"}},"player_id":{"name":"player_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"PLAYER_ID"}},"player_template_id":{"name":"player_template_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"PLAYER_TEMPLATE_ID"}},"adunit_template_id":{"name":"adunit_template_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"ADUNIT_TEMPLATE_ID"}},"ad_schedule_id":{"name":"ad_schedule_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"AD_SCHEDULE_ID"}},"playlist_id":{"name":"playlist_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"PLAYLIST_ID"},"description":"Playlist ID."},"ad_source_id":{"name":"ad_source_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"AdSource_ID"},"description":"AdSource ID."},"search":{"name":"search","in":"query","required":true,"style":"form","schema":{"type":"string","example":"Fox"},"description":"Search term for name field"},"searchPlaylist":{"name":"Playlist[search]","in":"query","required":false,"style":"form","schema":{"type":"string","example":"Fox"},"description":"Search term for name field"},"unit_id":{"name":"unit_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"0000"},"description":"Outstream unit id"},"user_id":{"name":"user_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"USER_ID"}},"video_id":{"name":"video_id","in":"path","required":true,"style":"simple","schema":{"type":"integer","example":"VIDEO_ID","description":"Video ID"}}},"schemas":{"200":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"Adtag":{"type":"object","properties":{"id":{"type":"integer","description":"","default":12684},"name":{"type":"string","description":"","default":"Ad tag"},"status":{"type":"boolean","description":"","default":true},"type":{"type":"string","description":"","default":"player"},"url_secure":{"type":"string","description":"","default":"AD_TAG_URL"},"geo_on":{},"geo":{},"cpm":{},"duration":{}}}}}},"paging":{"type":"object","properties":{"Adtag":{"type":"object","properties":{"page":{"type":"integer","description":"","default":1},"current":{"type":"integer","description":"","default":5},"count":{"type":"integer","description":"","default":5},"prevPage":{},"nextPage":{},"pageCount":{"type":"integer","description":"","default":1},"order":{"type":"object","properties":{"Adtag.id":{"type":"string","default":"desc"}}},"limit":{"type":"integer","description":"","default":10},"options":{"type":"array","items":{}},"paramType":{"type":"string","description":"","default":"querystring"},"queryScope":{}}}}}}}},"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}}}