Vidalytics Public API
\nSome endpoints are subject to rate limits — these are noted in their respective documentation.
\nWhen you reach your monthly usage limit for a rate-limited endpoint, the following applies:
\nYou can check your current usage and remaining quota at any time using the /stats/usage endpoint.
The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"cfddb932-ead5-4a0e-9c8e-d7564e92021b"},{"name":"Update video settings","id":"327e4615-79c6-4c60-bd28-1c351a98c730","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"video_title\": \"My updated title\",\n\n \"playback_autoplay_enabled\": false,\n \"playback_autoplay_loop_enabled\": false,\n \"playback_autoplay_loop_to\": 0,\n \"playback_autoplay_mobile\": false,\n \"playback_autoplay_only_muted\": false,\n \"playback_no_pause\": false,\n \"playback_on_end\": \"pause\",\n \"playback_resume\": true,\n \"playback_smart_pause\": false,\n \"playback_smart_pause_resume\": false,\n \"playback_skip_and_rewind_with_keyboard\": true,\n\n \"color_foreground\": \"#3974ff\",\n \"color_background\": \"#000000\",\n \"color_force\": false,\n\n \"control_bar_fullscreen_show\": true,\n \"control_bar_fullscreen_custom_default_enabled\": false,\n \"control_bar_fullscreen_custom_mobile_enabled\": false,\n \"control_bar_fullscreen_minimize_on_pause\": false,\n \"control_bar_fullscreen_expand_on_play\": false,\n \"control_bar_fullscreen_allow_scroll\": false,\n \"control_bar_play_show\": true,\n \"control_bar_pip_show\": false,\n \"control_bar_pip_auto_mode\": false,\n \"control_bar_rewind_show\": true,\n \"control_bar_seek_bar_show\": true,\n \"control_bar_seek_bar_position\": \"aboveControls\",\n \"control_bar_seek_bar_mode\": \"standard\",\n \"control_bar_seek_bar_show_to_returning_viewers\": false,\n \"control_bar_seek_bar_rapid_engage_desktop_speed\": 2,\n \"control_bar_seek_bar_rapid_engage_mobile_speed\": 2,\n \"control_bar_seek_bar_storybar_style\": \"storiesGrid\",\n \"control_bar_seek_bar_storybar_parts\": [{\"time\": 0, \"title\": \"Intro\"}, {\"time\": 30, \"title\": \"Main\"}],\n \"control_bar_speed_control_show\": true,\n \"control_bar_quality_control_show\": true,\n \"control_bar_volume_show\": true,\n \"control_bar_always_show\": false,\n \"control_bar_playback_timer_show\": true,\n \"control_bar_allow_seek_navigation\": true,\n \"control_bar_hide_on_pause\": false,\n \"control_bar_progress_line_show\": true,\n \"control_bar_progress_line_position\": \"bottom\",\n \"control_bar_progress_line_color\": \"#3974ff\",\n \"control_bar_progress_line_color_opacity\": 1.0,\n \"control_bar_progress_line_visibility\": \"always\",\n \"control_bar_accessibility_tooltips\": true,\n\n \"overlay_play_button_show\": true,\n \"overlay_play_seek_buttons_show\": false,\n\n \"overlay_redirect_show\": false,\n \"overlay_redirect_url\": \"https://example.com\",\n \"overlay_redirect_text\": \"Learn more\",\n \"overlay_redirect_timeout\": 5,\n \"overlay_redirect_color_foreground\": \"#ffffff\",\n \"overlay_redirect_color_background\": \"#3974ff\",\n\n \"overlay_resume_show\": true,\n \"overlay_resume_text\": \"You left off here\",\n \"overlay_resume_button_replay_text\": \"Replay\",\n \"overlay_resume_button_resume_text\": \"Resume\",\n \"overlay_resume_color_foreground\": \"#ffffff\",\n \"overlay_resume_color_background\": \"#3974ff\",\n\n \"overlay_unmute_type\": \"box\",\n \"overlay_unmute_do_replay\": false,\n \"overlay_unmute_fullscreen_default_enabled\": false,\n \"overlay_unmute_fullscreen_mobile_enabled\": false,\n \"overlay_unmute_mobile_enabled\": true,\n \"overlay_unmute_text_top\": \"Tap\",\n \"overlay_unmute_text_bottom\": \"to unmute\",\n \"overlay_unmute_mobile_text_top\": \"Tap\",\n \"overlay_unmute_mobile_text_bottom\": \"to unmute\",\n \"overlay_unmute_color_foreground\": \"#ffffff\",\n \"overlay_unmute_color_background\": \"#000000\",\n\n \"overlay_expire_enabled\": false,\n \"overlay_expire_date_expire\": \"2026-12-31T23:59:59+00:00\",\n \"overlay_expire_text_top\": \"This video has expired\",\n \"overlay_expire_text_bottom\": \"Please contact us\",\n \"overlay_expire_link_href\": \"https://example.com/expired\",\n \"overlay_expire_link_blank\": true,\n \"overlay_expire_color_foreground\": \"#ffffff\",\n \"overlay_expire_color_background\": \"#000000\",\n\n \"overlay_pause_enabled\": false,\n\n \"theme_name\": \"sleek\",\n \"theme_border_radius\": 4,\n \"theme_opacity_level\": 80,\n \"theme_frame_radius\": 0,\n\n \"player_startup_quality\": \"auto\",\n \"player_lower_bandwidth_usage\": false,\n \"player_playback_rate\": 1.0\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/settings","urlObject":{"path":["video",":video_id","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"f0cb4b3c-b22e-4888-b074-5714684f82f9","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"327e4615-79c6-4c60-bd28-1c351a98c730"}],"id":"92c8a1d5-a1f6-4ebf-9d1f-bc7651e45149","_postman_id":"92c8a1d5-a1f6-4ebf-9d1f-bc7651e45149","description":""},{"name":"publish","item":[{"name":"Publish video","id":"6440218b-353c-4de1-967a-e80235ac4ee2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/publish","urlObject":{"path":["video",":video_id","publish"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"2beb8802-14ad-4a9f-9d0d-ff6dc1c6c4e8","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"6440218b-353c-4de1-967a-e80235ac4ee2"}],"id":"c5969e52-2225-4f38-a0c9-21a8be2f044d","_postman_id":"c5969e52-2225-4f38-a0c9-21a8be2f044d","description":""},{"name":"duplicate","item":[{"name":"Duplicate video","id":"d46772f6-bf59-4f1f-a319-5ef02b13719c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","description":"Creates a copy of the video with all settings, thumbnails, CTAs, triggers, playgates, conversions and closed captions. The duplicate is placed in the same folder as the source and published immediately.
\n","urlObject":{"path":["video",":video_id","duplicate"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"2ffea457-8e43-4187-80ca-5490d54b1209","description":{"content":"The GUID of the video to duplicate
\n","type":"text/plain"},"type":"any","value":"","key":"video_id"}]}},"response":[{"id":"a58f63ef-0956-41c8-af94-ce2f22d93c7c","name":"Video duplicated successfully","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id","duplicate"],"variable":[{"key":"video_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"content\": {\n \"data\": {\n \"id\": \"saQ9pDKsbejs0weH\",\n \"title\": \"My Video Duplicate\",\n \"date_created\": \"2026-05-01 12:00:00\",\n \"folder_id\": \"f0lder-guid-here\",\n \"embedGuid\": \"embed-guid-here\"\n }\n }\n}"},{"id":"537d2c3f-7fc7-439c-8103-aa247664f23c","name":"Video not found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id","duplicate"],"variable":[{"key":"video_id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"error\": {\n \"code\": 404,\n \"message\": \"Video \\\"a1b2c3d4\\\" not found in your account.\"\n }\n}"}],"_postman_id":"d46772f6-bf59-4f1f-a319-5ef02b13719c"}],"id":"305db0d7-44e8-4616-bc77-b5293cf53fb0","_postman_id":"305db0d7-44e8-4616-bc77-b5293cf53fb0","description":""},{"name":"thumbnail","item":[{"name":"pause-screen","item":[{"name":"List pause screens","id":"cd271af3-efeb-4c33-95ff-0302c54a2862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c29279a1-a41c-430a-9c86-9f1868ae0044","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"cd271af3-efeb-4c33-95ff-0302c54a2862"},{"name":"Upload pause screen","id":"988e997d-2400-4b65-8e21-a01011fb14c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","description":"Binary content of the pause screen image
\n","value":null},{"key":"time_from","value":"10","type":"text","description":"Start time in seconds
\n"},{"key":"time_to","value":"20","type":"text","description":"End time in seconds
\n"}]},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"6b255759-48f5-45d7-879f-4cac744fb95d","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"988e997d-2400-4b65-8e21-a01011fb14c6"},{"name":"Delete all pause screens","id":"dc098de1-d5e0-4763-b4de-990a7a9b30a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"6e964218-a95c-4108-8b60-2e6f6188c651","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"dc098de1-d5e0-4763-b4de-990a7a9b30a7"},{"name":"Update pause screen timing","id":"f37b5c36-47d3-4b30-befc-1ac0a2029c9f","request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"time_from\": 20,\n \"time_to\": 30\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen/:thumbnail_guid","description":"Update time_from and/or time_to for a specific pause screen. Accepts JSON body.
\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen",":thumbnail_guid"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"b2aa501e-4f37-442b-a530-823ee4e6cace","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"eb6cb57d-d2e4-41f1-a6be-8750434b417c","description":{"content":"The GUID of the pause screen to update
\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"f37b5c36-47d3-4b30-befc-1ac0a2029c9f"},{"name":"Delete pause screen by GUID","id":"0a6e069c-3085-4878-8d5a-0f6ce6b8004f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen/:thumbnail_guid","urlObject":{"path":["video",":video_id","thumbnail","pause-screen",":thumbnail_guid"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"a1a5fd2a-3f4b-4b3a-9c92-6e554942101d","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"9a2c793a-5744-41ee-99c6-5711d28f2adf","description":{"content":"The GUID of the pause screen thumbnail
\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"0a6e069c-3085-4878-8d5a-0f6ce6b8004f"}],"id":"971f0a73-7bd3-4cb4-885b-63e3c772bf3c","_postman_id":"971f0a73-7bd3-4cb4-885b-63e3c772bf3c","description":""},{"name":"Get thumbnails","id":"6123003d-1f57-45ad-b9d9-b0225e50dfec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"80199c02-e99e-41e5-b4d7-a7557a6d524f","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"6123003d-1f57-45ad-b9d9-b0225e50dfec"},{"name":"Upload thumbnail","id":"249251da-a785-416b-ac18-77f06f02d2b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://example.com/thumbnail.png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c44be341-c5ba-437a-8034-a9fc67eea117","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"249251da-a785-416b-ac18-77f06f02d2b3"},{"name":"Update thumbnail config","id":"2bb76232-5d6a-4d49-b10d-9f6464b90b92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"thumbnail_default_type\": \"image\",\n \"thumbnail_video_guid\": null,\n \"thumbnail_default_from\": null,\n \"thumbnail_default_to\": null,\n \"thumbnail_mobile_type\": \"image\",\n \"thumbnail_mobile_video_guid\": null,\n \"thumbnail_mobile_from\": null,\n \"thumbnail_mobile_to\": null,\n \"thumbnail_full_size\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/settings","urlObject":{"path":["video",":video_id","thumbnail","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"bead2208-94bf-44f8-aa25-6e3d377facd3","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"2bb76232-5d6a-4d49-b10d-9f6464b90b92"},{"name":"Delete thumbnail","id":"ed843151-fc29-4473-8444-1d9b9c818696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"005d05f8-22e8-416e-a47b-20ebb98b756a","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"ed843151-fc29-4473-8444-1d9b9c818696"},{"name":"Upload mobile thumbnail","id":"2445b9d3-cef9-4d47-9f0c-91c716bcda8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://example.com/mobile-thumbnail.png\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/mobile","urlObject":{"path":["video",":video_id","thumbnail","mobile"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"e316614e-a802-4c64-a7cc-255c724c0138","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"2445b9d3-cef9-4d47-9f0c-91c716bcda8b"},{"name":"Delete mobile thumbnail","id":"643dd48c-a640-4c73-8f7b-cdb5637fdb8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/mobile","urlObject":{"path":["video",":video_id","thumbnail","mobile"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"74f57762-7a7e-42c1-9dcb-1e6a1226d9d7","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"643dd48c-a640-4c73-8f7b-cdb5637fdb8a"}],"id":"39a5f3b9-2fa4-47d6-999d-d0abc687020b","_postman_id":"39a5f3b9-2fa4-47d6-999d-d0abc687020b","description":""},{"name":"call-to-action","item":[{"name":"List CTAs","id":"d9ee6fb3-e6d1-4e55-8d6f-da319e97b6e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/call-to-action","urlObject":{"path":["video",":video_id","call-to-action"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"7bb61eca-e1c3-4704-bbaa-f4c58d831c97","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"d9ee6fb3-e6d1-4e55-8d6f-da319e97b6e5"},{"name":"Create CTA","id":"bb94add5-8298-4c27-ae52-a66e09cb0eb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Click here\",\n \"link\": \"https://example.com\",\n \"link_in_new_window\": true,\n \"time_from\": 0,\n \"time_to\": 30,\n \"type\": \"button\",\n \"display_mode\": \"always\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/call-to-action","urlObject":{"path":["video",":video_id","call-to-action"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"8c0bc1c3-fde6-4b86-b6a3-3664b9129011","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"bb94add5-8298-4c27-ae52-a66e09cb0eb3"},{"name":"Update CTA","id":"f20d0b49-73f2-447a-b512-08f96912b085","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"Click here\",\n \"link\": \"https://example.com\",\n \"link_in_new_window\": true,\n \"time_from\": 0,\n \"time_to\": 30,\n \"type\": \"button\",\n \"display_mode\": \"always\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/call-to-action/:cta_id","urlObject":{"path":["video",":video_id","call-to-action",":cta_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"fc898d60-3338-4b8f-9ead-304104429052","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"1dbb366d-6f61-4c94-91d9-8e9967d03d2f","description":{"content":"The ID of the CTA
\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"f20d0b49-73f2-447a-b512-08f96912b085"},{"name":"Delete CTA","id":"ba4691e6-e052-4325-9493-493bc950dc3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/call-to-action/:cta_id","urlObject":{"path":["video",":video_id","call-to-action",":cta_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"e46e6a11-1995-4f29-b17d-de1207f51303","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"7b608530-6af1-4afe-85d8-11c4c56983ee","description":{"content":"The ID of the CTA
\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"ba4691e6-e052-4325-9493-493bc950dc3b"}],"id":"becb8483-66ea-423c-bd7a-92ca7347d1ec","_postman_id":"becb8483-66ea-423c-bd7a-92ca7347d1ec","description":""},{"name":"Get details on a single video by ID","id":"6eaca342-d069-4e66-9717-b5a23074bfde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id","urlObject":{"path":["video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"b9ab6e2f-3008-4951-9e24-ef74f473aa04","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"a74cfc16-1b7e-4d7e-83a0-9d209aa7c687","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Look up a single video by its embed code GUID.
\n","urlObject":{"path":["video"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"The GUID of the embed code to look up the associated video.
\n","type":"text/plain"},"key":"embedGuid","value":"{{embedGuid}}"}],"variable":[]}},"response":[{"id":"bf84128f-c326-492e-800a-d6341afbb913","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"1ec45298-7477-450a-9e62-5666c792561f","name":"Video updated successfully","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"907a1cd5-6e0b-4022-ba3f-78b9dbb675b6","name":"Video deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Title of the video
\n","key":"title","value":"my-test-name.avi","type":"text"},{"description":"URL of the remote video file
\n","key":"url","value":"https://jsoncompare.org/LearningContainer/SampleFiles/Video/MP4/sample-mp4-file.mp4","type":"text"},{"description":"Binary content of the video file being uploaded
\n","key":"file","type":"file","value":null}]},"url":"https://api.vidalytics.com/public/v1/video/upload","urlObject":{"path":["video","upload"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"c69cead4-c835-49f5-8779-c469f2239343","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Returns a list of all videos. Optionally filters by embed code GUID to retrieve a single matching video.
\n","urlObject":{"path":["video"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"(optional) Filter by embed GUID.
\n","type":"text/plain"},"key":"embedGuid","value":"{{embedGuid}}"}],"variable":[]}},"response":[{"id":"67ddf478-a482-44b8-9169-9be45f9233c8","name":"ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"b7ce0ef8-8505-4512-9a0a-c9dad76164bf","name":"Video retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Returns viewer drop-off statistics showing how many viewers remain watching at each second of the video.
\nNote: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.
date from for filter
\n","type":"text/plain"},"key":"dateFrom","value":"2020-01-01"},{"description":{"content":"date to for filter
\n","type":"text/plain"},"key":"dateTo","value":"2023-02-01"}],"variable":[{"id":"a6b053b7-a0a4-46df-abf6-ffc7fc2ea1b2","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"1ed0f59c-e9c6-400f-a10c-d6a9fb29bb16","name":"ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Returns real-time metrics for the specified video, such as current viewers watching.
\nNote: This endpoint is only available to Enterprise customers.
\n","urlObject":{"path":["stats","video",":video_id","live-metrics"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"4c5a0d34-f1fe-47bf-a081-de034f197286","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"111defce-58b0-4ee0-bc14-204fe1b319a0","name":"Live metrics retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Returns total statistics for the specified video within the given date range.
\nNote: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.
date from for filter
\n","type":"text/plain"},"key":"dateFrom","value":"2020-01-01"},{"description":{"content":"date to for filter
\n","type":"text/plain"},"key":"dateTo","value":"2023-02-01"}],"variable":[{"id":"473fef94-9c72-4a32-8b62-f7ab9b332625","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"4517d9c8-5fef-42df-b452-3216648d2c10","name":"ok","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"Returns the current API usage, including monthly limit, current usage, and remaining requests.
\nUsage Information:
\nmonthly_limit: Maximum number of API requests allowed per billing period (null means unlimited)current_usage: Number of API requests made in the current billing periodremaining: Number of requests remaining (null if unlimited)Returns timeline data with metrics grouped by segments and dates.
\nNote: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.
Restrictions:
\nAvailable Filter Types:
\nfilter.browsers - Filter by browser typesfilter.conversions - Filter by conversion GUIDsfilter.devices - Filter by device typesfilter.geo - Filter by country codes (ISO 3166-1 alpha-3)filter.url_params.<param> - Filter by URL parameter valuesComma-separated list of video GUIDs to retrieve timeline for (max 5)
\n","type":"text/plain"},"key":"videoGuids","value":"testvid1,testvid2"},{"description":{"content":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.\nAvailable metrics:
\nStart date for the timeline range
\n","type":"text/plain"},"key":"dateFrom","value":"2025-01-01"},{"description":{"content":"End date for the timeline range (max 1 month from dateFrom)
\n","type":"text/plain"},"key":"dateTo","value":"2025-01-31"},{"description":{"content":"Available segments:
\nComma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params
\n","type":"text/plain"},"key":"segmentParams","value":"utm_medium"},{"description":{"content":"Comma-separated list of browsers to filter by
\n","type":"text/plain"},"key":"filter.browsers","value":"chrome,safari,firefox"},{"description":{"content":"Comma-separated list of conversion GUIDs to filter by
\n","type":"text/plain"},"key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":{"content":"Comma-separated list of devices to filter by
\n","type":"text/plain"},"key":"filter.devices","value":"desktop,mobile"},{"description":{"content":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)
\n","type":"text/plain"},"key":"filter.geo","value":"USA,GBR,CAN"},{"description":{"content":"Filter by URL parameter values. This is a pattern parameter where {paramName} should be replaced with the actual URL parameter name you want to filter by.
Pattern: filter.url_params.{paramName}=value1,value2
Examples:
\nfilter.url_params.affiliates=aff1,aff2 - Filter by affiliates parameterfilter.url_params.utm_source=google,facebook - Filter by utm_source parameterfilter.url_params.campaign=summer,winter - Filter by campaign parameterYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.
\n","type":"text/plain"},"key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}],"variable":[]}},"response":[{"id":"38434407-8866-4e33-877b-1b8823e1d0f7","name":"Timeline data retrieved successfully","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"The ID of the folder to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"fd6ddcad-82f9-4d4c-8bb3-4c774c4d2576","name":"The folder entity","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"ID of the folder
\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"baea7cdc-2d06-4312-8c93-d4b1794ef609","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"ID of the folder
\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"33da1def-45a1-4cd8-a01c-c02899f3bff7","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"The ID of the settings template
\n","type":"text/plain"},"type":"any","value":"string","key":"template_id"}]}},"response":[],"_postman_id":"d51629bc-333e-40cb-a114-e88ee3a6ae73"}],"id":"ebf82c8b-1b06-4a1c-9b2d-2d74d3fdbcbe","_postman_id":"ebf82c8b-1b06-4a1c-9b2d-2d74d3fdbcbe","description":""}],"variable":[{"key":"baseUrl","value":"https://api.vidalytics.com/public/v1"}]}