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":"ad2c6af8-84ad-4a5d-a8fc-a9eb91e7a64f"},{"name":"Update video settings","id":"476b2aec-acff-4047-b24d-2e11beccf39f","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":"800a744d-e96d-4132-8d75-d5c6a5fbe53b","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"476b2aec-acff-4047-b24d-2e11beccf39f"}],"id":"8a852db5-6347-46d6-988a-5bf0242492de","_postman_id":"8a852db5-6347-46d6-988a-5bf0242492de","description":""},{"name":"publish","item":[{"name":"Publish video","id":"177b24eb-5be5-4914-b26b-039a4ced5ae1","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":"9a2e5ad1-a7b3-42d5-898a-3541151921fd","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"177b24eb-5be5-4914-b26b-039a4ced5ae1"}],"id":"76bc1665-1ced-4e47-81e1-51b3fa9443a7","_postman_id":"76bc1665-1ced-4e47-81e1-51b3fa9443a7","description":""},{"name":"duplicate","item":[{"name":"Duplicate video","id":"255b8832-0581-474a-b571-e590071937af","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":"5211e947-82b0-439b-bfe5-7dfc5fca42b1","description":{"content":"The GUID of the video to duplicate
\n","type":"text/plain"},"type":"any","value":"","key":"video_id"}]}},"response":[{"id":"fc24f2d4-b84c-4fd4-a4bf-912291e01af9","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":"36982c2c-6ea6-4212-b1b8-5e2e6904ac96","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":"255b8832-0581-474a-b571-e590071937af"}],"id":"e6a39ae5-6ad7-4427-a3b1-f0dde0744975","_postman_id":"e6a39ae5-6ad7-4427-a3b1-f0dde0744975","description":""},{"name":"thumbnail","item":[{"name":"pause-screen","item":[{"name":"List pause screens","id":"dd3c4d18-ae4c-4ab5-86e2-3301fc2a91a7","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":"42268e38-1a35-49cb-885d-6107c10e9b49","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"dd3c4d18-ae4c-4ab5-86e2-3301fc2a91a7"},{"name":"Upload pause screen","id":"e7fd3866-eae4-43f4-a698-7e4a30f97120","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":"ac115125-56db-4942-b32f-5d7391e44676","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"e7fd3866-eae4-43f4-a698-7e4a30f97120"},{"name":"Delete all pause screens","id":"98117d47-cf85-425a-a051-2a4db56a388d","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":"0254cd95-3925-4e31-a7fc-de0eff9e3d8f","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"98117d47-cf85-425a-a051-2a4db56a388d"},{"name":"Update pause screen timing","id":"55c61d9e-c100-4db9-b063-fbb2057ee150","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":"76e83d18-2fe8-4d5c-b0db-87a4b00fe417","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"4323abb0-ada9-4510-b3e5-46401acdf683","description":{"content":"The GUID of the pause screen to update
\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"55c61d9e-c100-4db9-b063-fbb2057ee150"},{"name":"Delete pause screen by GUID","id":"584b67d4-6b60-4f8c-8f1d-6c92f97a13c3","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":"f61ad21a-b0ca-4cb0-936d-a7ec90335fe9","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"a17a3fa7-bc82-4663-9e1f-abc708b41a72","description":{"content":"The GUID of the pause screen thumbnail
\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"584b67d4-6b60-4f8c-8f1d-6c92f97a13c3"}],"id":"928a232a-322b-4d2f-a91b-3c23ef3423f8","_postman_id":"928a232a-322b-4d2f-a91b-3c23ef3423f8","description":""},{"name":"Get thumbnails","id":"152403ae-0d92-4020-b61e-532977e12a96","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":"dd1c30d0-44f7-4c9d-98cf-2ac1183eade8","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"152403ae-0d92-4020-b61e-532977e12a96"},{"name":"Upload thumbnail","id":"19da6850-a340-4c26-b7a6-e075a760ec2a","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":"252f830e-5af8-4723-afa7-4890f318d66e","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"19da6850-a340-4c26-b7a6-e075a760ec2a"},{"name":"Update thumbnail config","id":"4aa3fed6-bf9f-41f7-9e2e-0dacde5b20e4","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":"136eed50-1da6-412c-950a-3bce0316c660","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"4aa3fed6-bf9f-41f7-9e2e-0dacde5b20e4"},{"name":"Delete thumbnail","id":"74de02a8-6363-4447-8694-6a26435f1086","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":"95be8baa-9b0d-4250-8f6a-644ff898b2b5","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"74de02a8-6363-4447-8694-6a26435f1086"},{"name":"Upload mobile thumbnail","id":"3e32bf96-03f8-4051-b201-5d53c111e9c8","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":"3c5fad66-fb48-4c57-bcf9-42702ae8e437","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"3e32bf96-03f8-4051-b201-5d53c111e9c8"},{"name":"Delete mobile thumbnail","id":"6734c934-5f8e-4976-8bbd-d6066fee1a81","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":"cc2fca3f-8573-44fb-b115-c71e83c328ba","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"6734c934-5f8e-4976-8bbd-d6066fee1a81"}],"id":"bffdf58b-6940-4703-b52a-9ee6f2161bb6","_postman_id":"bffdf58b-6940-4703-b52a-9ee6f2161bb6","description":""},{"name":"call-to-action","item":[{"name":"List CTAs","id":"54d812e8-a183-46c0-8784-0007e87c4663","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":"76f8234b-4815-4051-9fa9-1018611bbe63","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"54d812e8-a183-46c0-8784-0007e87c4663"},{"name":"Create CTA","id":"d4e5afd8-c0de-42d4-91f3-701a81622dfd","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":"ff6b91b7-e04d-45a0-85b6-7f84b24fd45a","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"d4e5afd8-c0de-42d4-91f3-701a81622dfd"},{"name":"Update CTA","id":"93b55848-9ba5-484f-b420-76dbf676ee52","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":"3fa72f5d-42d8-465b-b6ed-9a77932399ce","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"a1dbc467-464c-4bd0-a283-ecd74655c7e7","description":{"content":"The ID of the CTA
\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"93b55848-9ba5-484f-b420-76dbf676ee52"},{"name":"Delete CTA","id":"d7212b65-b144-4234-acd7-b8d2cbba3767","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":"4d9ac5dd-88ac-440e-81cf-1c901a9e6fef","description":{"content":"The ID of the video
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"0e17a147-c725-4927-8227-2acaf0b66764","description":{"content":"The ID of the CTA
\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"d7212b65-b144-4234-acd7-b8d2cbba3767"}],"id":"d434a71e-266a-47e0-bb30-59a9634c6afd","_postman_id":"d434a71e-266a-47e0-bb30-59a9634c6afd","description":""},{"name":"Get details on a single video by ID","id":"b16309db-b6eb-4f1b-be9a-03696fae7b13","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":"35fa4de8-13ae-4a3f-91f3-8cd7487ac358","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"bbd0c920-bb15-4a54-9bc1-1eb46359495e","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":"f17fd918-bb90-4712-a8ed-7e5f689562e8","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":"ca49c216-f59e-478e-90be-087da4c13f81","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":"ab13c56b-ab0d-40fd-91c4-542b9f497645","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":"7d30b762-25cd-4465-a1f3-6e3bdd7c9bf7","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":"4a805407-dd87-4976-870e-249768fd8d1e","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":"dc45e94f-56bc-4495-b45b-6212ed79dfcc","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":"65f17142-183b-4682-83db-06365d919f7d","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"9d81e1db-398e-4b72-b4ed-ca92d775de27","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":"580db365-f877-4c88-941d-260ffb178e7c","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"6118c424-0be1-481f-868e-5525e3dc5118","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":"4ac78d2f-8480-4acc-9d88-6c0ff627d09c","description":{"content":"The ID of the video to retrieve
\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"5900a6c8-acaa-4878-b4d8-ec1031e251a5","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":"26e375a6-6d2e-42bd-9be0-dd6afbcb1bf2","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":"d0d3d20a-06f2-4dc1-b0b2-eb295f4a444f","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":"f3984243-1488-47a1-8c2f-8bd5c290db03","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":"ffeb0421-9d03-4a5d-bca2-180292f2fd11","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":"759dd36f-81b5-453e-9079-03cbbbf888e6"}],"id":"d67058c5-428e-45c9-9db0-ff978d7f5f64","_postman_id":"d67058c5-428e-45c9-9db0-ff978d7f5f64","description":""}],"variable":[{"key":"baseUrl","value":"https://api.vidalytics.com/public/v1"}]}