{"info":{"_postman_id":"8d084dd7-174a-4539-91ef-a3a7497a05ef","name":"Vidalytics Public API","description":"

Vidalytics Public API

\n

Usage Limits

\n

Some endpoints are subject to rate limits — these are noted in their respective documentation.

\n

When you reach your monthly usage limit for a rate-limited endpoint, the following applies:

\n
    \n
  1. Normal Operation — Requests count toward your monthly quota as usual.
    2. \n
  2. Monthly Limit Reached — You can continue making requests, but at a reduced rate.
    3. \n
  3. Throttle Exceeded — If you exceed the hourly throttle limit, the API will return a 429 Too Many Requests error.
    4. \n
\n

You can check your current usage and remaining quota at any time using the /stats/usage endpoint.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25796407","collectionId":"8d084dd7-174a-4539-91ef-a3a7497a05ef","publishedId":"2sB3dMxrGJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-03T11:14:00.000Z"},"item":[{"name":"video","item":[{"name":"{video_id}","item":[{"name":"settings","item":[{"name":"Get video settings","id":"acf467c8-cc03-4e98-9896-4e0acca98d04","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/settings","urlObject":{"path":["video",":video_id","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"03117943-fd95-4d5d-93d2-7c2620857c6d","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"acf467c8-cc03-4e98-9896-4e0acca98d04"},{"name":"Update video settings","id":"1b27e2d2-06b1-44c3-b9d2-0b66a417c691","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_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":"5647a4e3-e11f-4a7a-a9fa-8ccf6d29b498","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"1b27e2d2-06b1-44c3-b9d2-0b66a417c691"}],"id":"2c9f2eed-f845-4081-8400-dd68faba5c93","_postman_id":"2c9f2eed-f845-4081-8400-dd68faba5c93","description":""},{"name":"publish","item":[{"name":"Publish video","id":"a5f0c1c8-63b7-4741-93cb-5a940d1986c6","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":"a89a90c6-44a8-4ae5-8268-a5ecaa03ce2b","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"a5f0c1c8-63b7-4741-93cb-5a940d1986c6"}],"id":"17b06a94-5efb-4d39-96b0-520e72e21320","_postman_id":"17b06a94-5efb-4d39-96b0-520e72e21320","description":""},{"name":"thumbnail","item":[{"name":"pause-screen","item":[{"name":"List pause screens","id":"9f9a720d-88cb-43dd-8bc4-27560b5aa497","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":"b5731aa1-9d79-4da1-aeeb-6f81d1a97c93","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"9f9a720d-88cb-43dd-8bc4-27560b5aa497"},{"name":"Upload pause screen","id":"979cb5b9-0bf0-4d30-b6e7-7ec7cd4ad2e8","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":"004444cd-4253-4162-a0b2-8207a982695b","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"979cb5b9-0bf0-4d30-b6e7-7ec7cd4ad2e8"},{"name":"Delete all pause screens","id":"51ac179c-c68d-49c5-a240-14fe432bf287","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":"bacbd08c-83fc-47e8-bb0d-dae47156964f","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"51ac179c-c68d-49c5-a240-14fe432bf287"},{"name":"Update pause screen timing","id":"cda34dff-90b5-48cc-987e-c9c062fe7747","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":"0cc1e80c-a0e3-43eb-adad-1ccd4f3f88aa","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"891c86c6-0d65-4b47-88e0-3c85288e2f46","description":{"content":"

The GUID of the pause screen to update

\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"cda34dff-90b5-48cc-987e-c9c062fe7747"},{"name":"Delete pause screen by GUID","id":"dcad2cdc-aaa3-4387-b638-306db168e7e2","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":"22b81190-674d-4ca9-bfff-5df57dce6697","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"e04e86e3-b87f-49ae-a2f7-26634aba47de","description":{"content":"

The GUID of the pause screen thumbnail

\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"dcad2cdc-aaa3-4387-b638-306db168e7e2"}],"id":"26ce1235-0c96-40d8-9b5f-9b33f3a87aa6","_postman_id":"26ce1235-0c96-40d8-9b5f-9b33f3a87aa6","description":""},{"name":"Get thumbnails","id":"614a8687-4fdd-44f2-a453-f6e48db4469d","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":"3af28729-ddad-4161-9f2b-a22118591ad1","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"614a8687-4fdd-44f2-a453-f6e48db4469d"},{"name":"Upload thumbnail","id":"6ce38203-1d83-4fd4-bca9-272e65b8d414","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":"96952051-f49e-413c-93fe-a66cb49b324a","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"6ce38203-1d83-4fd4-bca9-272e65b8d414"},{"name":"Update thumbnail config","id":"53cc427d-6094-4035-b46b-03037b1eab1e","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":"6e5d666b-7016-4647-b2fa-564b654891c2","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"53cc427d-6094-4035-b46b-03037b1eab1e"},{"name":"Delete thumbnail","id":"3cdcfe19-69ba-4b17-80e8-193f517dca49","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":"1a977e36-c469-44f4-b69e-3c09ecac5ee5","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"3cdcfe19-69ba-4b17-80e8-193f517dca49"},{"name":"Upload mobile thumbnail","id":"d3c9ac39-6ce8-433e-9466-097f41df8ab5","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":"8a5c187d-67a4-4b85-9ae5-838db67cc42d","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"d3c9ac39-6ce8-433e-9466-097f41df8ab5"},{"name":"Delete mobile thumbnail","id":"e22be40f-7379-4f31-b134-a7acf9fe0296","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":"8508ddf9-58cc-443d-b0c3-f2e043ba5a83","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"e22be40f-7379-4f31-b134-a7acf9fe0296"}],"id":"0f9700a4-eccb-4f38-8471-e98be8cf9a3f","_postman_id":"0f9700a4-eccb-4f38-8471-e98be8cf9a3f","description":""},{"name":"call-to-action","item":[{"name":"List CTAs","id":"06bc3191-3e1e-43de-a5d1-41c4732c6c38","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":"0de0f62e-0c9f-4979-ac30-8dfdd5ca6efb","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"06bc3191-3e1e-43de-a5d1-41c4732c6c38"},{"name":"Create CTA","id":"799107cb-6936-4b75-81f7-98f1097758d8","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":"56141a2d-a5d8-4e83-861d-0d6b3434c83a","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"799107cb-6936-4b75-81f7-98f1097758d8"},{"name":"Update CTA","id":"7311efed-3ff9-4082-b3ac-760c066dd30a","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":"ed6cbca0-6c00-47e7-8c73-da0be2198f40","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"a69f1ff0-81e5-4d3d-acef-b3b852aaf882","description":{"content":"

The ID of the CTA

\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"7311efed-3ff9-4082-b3ac-760c066dd30a"},{"name":"Delete CTA","id":"202e869a-f929-4167-aaf1-f2bd146b605d","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":"3c3f4e1d-152b-47d5-8449-632b41768ae7","description":{"content":"

The ID of the video

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"5a30e7da-b236-4b45-93cd-0a30b4a6d61e","description":{"content":"

The ID of the CTA

\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"202e869a-f929-4167-aaf1-f2bd146b605d"}],"id":"3b1802c3-28e3-4b1d-808e-8150c6161f71","_postman_id":"3b1802c3-28e3-4b1d-808e-8150c6161f71","description":""},{"name":"Get details on a single video by ID","id":"f8eec5f9-0ed1-4379-ae9d-03ab1fc3bb6f","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":"dad243ce-d0ca-49d7-9d8a-e3ddafbad74e","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"07975b00-5d99-4f00-b6bf-15e83d74dff1","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"content\": {\n \"data\": {\n \"id\": \"QwuRdTxz0l1HBGyA\",\n \"date_created\": \"2023-02-22 11:01:52\",\n \"last_published\": \"2023-02-22 11:04:37\",\n \"status\": \"processing\",\n \"views\": 0,\n \"folder_id\": \"KBTe1Aumq1mPDu6G\",\n \"thumbnail\": {\n \"desktop\": \"https://quick.vidalytics.com/thumbs/desc/dasf0al.png\",\n \"mobile\": \"https://quick.vidalytics.com/thumbs/mobile/21da2sf.png\"\n },\n \"url\": \"https://quick.vidalytics.com/video/88181/iv-mobile-on-square.mp4\"\n }\n }\n}"},{"id":"5c3bda5c-4bf0-4dad-9bcd-3247fbc3c7a5","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"278313c2-a3d6-4b08-8c21-411de497672e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"1c27bec6-f30c-40ae-923e-a37235772bc2","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f8eec5f9-0ed1-4379-ae9d-03ab1fc3bb6f"},{"name":"Update a video","id":"e8030442-3955-40bb-89bb-d53307dda9b8","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":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"folder_id\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"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":"a43968e8-e100-4f0c-a580-947ab966fafb","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"edbc85b9-1f43-4dee-bb43-18b5d09ab460","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":""}],"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"folder_id\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"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\": \"RpZOGcMe4Hpe1LI5\",\n \"title\": \"string\",\n \"date_created\": \"1981-04-24T14:35:28.440Z\",\n \"last_published\": \"1968-10-22T22:44:30.389Z\",\n \"status\": \"ready\",\n \"views\": 3195,\n \"url\": \"string\",\n \"thumbnail\": {\n \"desktop\": \"string\",\n \"mobile\": \"string\"\n },\n \"folder_id\": \"string\"\n }\n }\n}"},{"id":"f7da1159-aac0-434c-a2d4-93e09573102a","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"folder_id\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"0c4ab613-3793-450d-92eb-5f1a170590ea","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"folder_id\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"f426a342-2793-42af-bd57-a41e3ea44317","name":"Video not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"title\": \"string\",\n \"folder_id\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e8030442-3955-40bb-89bb-d53307dda9b8"},{"name":"Delete a video","id":"e032da86-6999-4b77-9c1b-5110c53c6bf0","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","urlObject":{"path":["video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"f5496a01-9550-49ad-8bbb-bbde0eb75fb8","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"bec3d2d1-6622-4fe5-9be5-354c1a51b521","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"message\": \"Video deleted successfully\"\n}"},{"id":"28521cfa-0f38-4154-9cc7-fac72868c5a6","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"82fea87d-905e-41f0-835a-edee0c49258f","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4eb3556b-79c0-4479-99a5-4b65b6c894a2","name":"Video not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"65cac8bd-38da-4d41-9fad-14aefe2bad54","name":"Internal server error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e032da86-6999-4b77-9c1b-5110c53c6bf0"}],"id":"914003be-0944-4ff6-91d9-18ddb20e9f02","_postman_id":"914003be-0944-4ff6-91d9-18ddb20e9f02","description":""},{"name":"upload","item":[{"name":"Upload a new video","id":"c9bfed3c-23aa-4536-a42a-8884390e1776","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":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"description":"

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":"4379ce48-b3f1-4e48-9ed5-1f3f335e58c5","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":""}],"body":{"mode":"formdata","formdata":[{"description":"Title of the video","key":"title","value":"my-test-name.avi","type":"text"},{"description":"URL of the remote video file","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","key":"file","type":"file","src":[]}]},"url":"https://api.vidalytics.com/public/v1/video/upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"content\": {\n \"data\": {\n \"id\": \"QwuRdTxz0l1HBGyA\",\n \"date_created\": \"2023-02-22 11:01:52\",\n \"last_published\": \"2023-02-22 11:04:37\",\n \"status\": \"processing\",\n \"folder_id\": \"KBTe1Aumq1mPDu6G\"\n }\n }\n}"},{"id":"bfc3b43a-a947-437f-9bb2-1de7f9b0ce83","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"formdata","formdata":[{"description":"Title of the video","key":"title","value":"my-test-name.avi","type":"text"},{"description":"URL of the remote video file","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","key":"file","type":"file","src":[]}]},"url":"https://api.vidalytics.com/public/v1/video/upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6f938727-2e3a-404f-905c-b512b7eed077","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"formdata","formdata":[{"description":"Title of the video","key":"title","value":"my-test-name.avi","type":"text"},{"description":"URL of the remote video file","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","key":"file","type":"file","src":[]}]},"url":"https://api.vidalytics.com/public/v1/video/upload"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c9bfed3c-23aa-4536-a42a-8884390e1776"}],"id":"e5768e0b-17f3-48ac-b66a-6960e9e3b022","_postman_id":"e5768e0b-17f3-48ac-b66a-6960e9e3b022","description":""},{"name":"Get a list of all videos","id":"87b45ef7-d511-4291-931e-cab12f828c0c","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","urlObject":{"path":["video"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"a264dc54-02c2-45dd-a2cc-4053d59badb0","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":""}],"url":"https://api.vidalytics.com/public/v1/video"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"content\": {\n \"data\": [\n {\n \"id\": \"RpZOGcMe4Hpe1LI5\",\n \"title\": \"string\",\n \"date_created\": \"1963-12-23T17:56:55.962Z\",\n \"last_published\": \"1979-02-18T02:41:37.759Z\",\n \"status\": \"ready\",\n \"folder_id\": \"string\"\n },\n {\n \"id\": \"RpZOGcMe4Hpe1LI5\",\n \"title\": \"string\",\n \"date_created\": \"1969-12-01T06:10:12.054Z\",\n \"last_published\": \"2014-07-05T08:39:37.759Z\",\n \"status\": \"ready\",\n \"folder_id\": \"string\"\n }\n ]\n }\n}"},{"id":"0acfc786-ac40-4f67-b7f6-77bca02ea401","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/video"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"286ab7c4-3e05-47b4-9586-cc1012e21887","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/video"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"87b45ef7-d511-4291-931e-cab12f828c0c"}],"id":"fb99ec41-f5ce-4c48-95a3-447e63af3689","_postman_id":"fb99ec41-f5ce-4c48-95a3-447e63af3689","description":""},{"name":"embed","item":[{"name":"video","item":[{"name":"{video_id}","item":[{"name":"Get video's HTML embed code by ID","id":"d9c5977b-6d09-49df-9c15-4a98aaca58c3","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/embed/video/:video_id","urlObject":{"path":["embed","video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"b6dd6ffb-ecd8-4d83-97b3-add85ec286ed","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"4d797a33-a243-4fe4-9c3f-ae21c8c0d145","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/embed/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["embed","video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"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\": \"RpZOGcMe4Hpe1LI5\",\n \"title\": \"string\",\n \"date_created\": \"2025-05-27T05:47:13.326Z\",\n \"last_published\": \"1994-02-06T07:56:25.826Z\",\n \"html\": \"string\",\n \"status\": \"ready\",\n \"views\": 8472,\n \"url\": \"string\",\n \"thumbnail\": {\n \"desktop\": \"string\",\n \"mobile\": \"string\"\n },\n \"folder_id\": \"string\"\n }\n }\n}"},{"id":"fc52ff5d-3a6e-4c8b-90ee-30cecc7496c0","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/embed/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["embed","video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"652204f0-6f8b-40a3-b041-99a364e20132","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/embed/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["embed","video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"d016823c-f45d-41c8-a5cf-6c81163ae624","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/embed/video/:video_id","host":["https://api.vidalytics.com/public/v1"],"path":["embed","video",":video_id"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d9c5977b-6d09-49df-9c15-4a98aaca58c3"}],"id":"280c98ea-a0df-4cd6-bc61-a6a5a2559138","_postman_id":"280c98ea-a0df-4cd6-bc61-a6a5a2559138","description":""}],"id":"14e2c087-b0c0-46c5-8ebc-7cb5dc0403d0","_postman_id":"14e2c087-b0c0-46c5-8ebc-7cb5dc0403d0","description":""}],"id":"f5652c81-ba8c-4256-84e2-cd8c1ebf4452","_postman_id":"f5652c81-ba8c-4256-84e2-cd8c1ebf4452","description":""},{"name":"stats","item":[{"name":"video","item":[{"name":"{video_id}","item":[{"name":"drop-off","item":[{"name":"Get viewer's drop-off statistics for a single video by ID","id":"d81c8ef7-26de-46e8-b49f-82956c7a4e8f","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/stats/video/:video_id/drop-off?dateFrom=2020-01-01&dateTo=2023-02-01","description":"

Returns viewer drop-off statistics showing how many viewers remain watching at each second of the video.

\n

Note: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.

\n","urlObject":{"path":["stats","video",":video_id","drop-off"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"

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":"9be8a7cc-0d2e-491b-96c9-d28ae86a9bbc","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"75050a83-dcdd-44b9-a079-d5304720db92","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/drop-off?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","drop-off"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"content\": {\n \"all\": {\n \"watches\": {\n \"0\": 200,\n \"5\": 190,\n \"10\": 80,\n \"15\": 50\n }\n }\n }\n}"},{"id":"b96f5bf5-f38c-4892-bf97-278fdc193131","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/drop-off?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","drop-off"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"15e8af43-ff9a-4cc4-858b-a5cf641bc356","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/drop-off?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","drop-off"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c18d66f4-068f-49a3-89e5-167dae898b72","name":"Rate limit exceeded. This can occur in two scenarios:\n\n1. **Monthly limit reached with throttling active**: You've reached your monthly limit and are now restricted to a reduced hourly rate. The error message will indicate the hourly limit.\n2. **Hard limi","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/drop-off?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","drop-off"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"error\": {\n \"code\": 429,\n \"message\": \"Limit exceeded. Current usage: 10000, Monthly limit: 10000\"\n }\n}"}],"_postman_id":"d81c8ef7-26de-46e8-b49f-82956c7a4e8f"}],"id":"bedf12d2-326a-4187-bc04-89fccde4d29d","_postman_id":"bedf12d2-326a-4187-bc04-89fccde4d29d","description":""},{"name":"live-metrics","item":[{"name":"Get live metrics for a single video","id":"5b16bf1e-2cab-4e93-a638-0b43c732a88e","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/stats/video/:video_id/live-metrics","description":"

Returns real-time metrics for the specified video, such as current viewers watching.

\n

Note: 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":"a9960572-f116-4058-ab2a-c6d47d4a8297","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"d3db9599-e1f8-4465-a4fd-37a39cf6eb63","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/live-metrics","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","live-metrics"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"content\": {\n \"watching\": 0\n }\n}"},{"id":"c25e0f8b-1149-456c-8305-ce08b0082d86","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/live-metrics","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","live-metrics"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"13d6821b-218a-475b-b8e4-28eefcf7f0f4","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/live-metrics","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","live-metrics"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"12a5bfc8-76b4-41ae-86ab-889ab3383dc3","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/live-metrics","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","live-metrics"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"0cbd7e24-1433-457f-b15b-2ded4311e3a9","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id/live-metrics","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id","live-metrics"],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5b16bf1e-2cab-4e93-a638-0b43c732a88e"}],"id":"aa08e612-6762-44b5-99f0-518e0654422b","_postman_id":"aa08e612-6762-44b5-99f0-518e0654422b","description":""},{"name":"Get total statistics for a single video by ID","id":"71a216e8-29c5-4bd5-bb3e-6627c3f42fcd","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/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","description":"

Returns total statistics for the specified video within the given date range.

\n

Note: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.

\n","urlObject":{"path":["stats","video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"

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":"d26d07e5-226d-45f2-baca-6c78e07f9401","description":{"content":"

The ID of the video to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"d07e44d5-eea5-467f-a505-56c3d8b13a36","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"content\": {\n \"plays\": 9866,\n \"playsUnique\": 5418,\n \"playRate\": 6626.609534677323,\n \"unmuteRate\": 8266.15031262998\n }\n}"},{"id":"a281664a-46c7-4510-87ec-63d04d473880","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c6b92472-8860-4d15-9dda-8f41b0545db4","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"caa4928f-272b-410f-a1e5-7982d3dec70c","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"2fb28060-f484-452c-8a33-483e5c90a3eb","name":"Rate limit exceeded. This can occur in two scenarios:\n\n1. **Monthly limit reached with throttling active**: You've reached your monthly limit and are now restricted to a reduced hourly rate. The error message will indicate the hourly limit.\n2. **Hard limi","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/video/:video_id?dateFrom=2020-01-01&dateTo=2023-02-01","host":["https://api.vidalytics.com/public/v1"],"path":["stats","video",":video_id"],"query":[{"description":"date from for filter","key":"dateFrom","value":"2020-01-01"},{"description":"date to for filter","key":"dateTo","value":"2023-02-01"}],"variable":[{"key":"video_id","value":"string","description":"The ID of the video to retrieve"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"error\": {\n \"code\": 429,\n \"message\": \"Limit exceeded. Current usage: 10000, Monthly limit: 10000\"\n }\n}"}],"_postman_id":"71a216e8-29c5-4bd5-bb3e-6627c3f42fcd"}],"id":"f1c19e34-02a1-46fc-86c1-f742e96f3aaa","_postman_id":"f1c19e34-02a1-46fc-86c1-f742e96f3aaa","description":""}],"id":"679dc452-d1c9-4224-a76e-0a1b6a3d2eaf","_postman_id":"679dc452-d1c9-4224-a76e-0a1b6a3d2eaf","description":""},{"name":"usage","item":[{"name":"Get current API usage limits","id":"c7397952-9787-4812-800a-ff596b0c8e22","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/stats/usage","description":"

Returns the current API usage, including monthly limit, current usage, and remaining requests.

\n

Usage Information:

\n
    \n
  • monthly_limit: Maximum number of API requests allowed per billing period (null means unlimited)
    • \n
  • current_usage: Number of API requests made in the current billing period
    • \n
  • remaining: Number of requests remaining (null if unlimited)
    • \n
\n","urlObject":{"path":["stats","usage"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"7bf895de-4d58-44d5-916b-0bc7ad4732ff","name":"Usage limit 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":""}],"url":"https://api.vidalytics.com/public/v1/stats/usage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"content\": {\n \"monthly_limit\": 10000,\n \"current_usage\": 2543,\n \"remaining\": 7457\n }\n}"},{"id":"c18e0745-83e2-4c82-8fca-d213dca395be","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/stats/usage"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"0a81cc56-b7a6-4482-aefd-0669e6e9a679","name":"Rate limit exceeded. This can occur in two scenarios:\n\n1. **Monthly limit reached with throttling active**: You've reached your monthly limit and are now restricted to a reduced hourly rate. The error message will indicate the hourly limit.\n2. **Hard limi","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/stats/usage"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"error\": {\n \"code\": 429,\n \"message\": \"Limit exceeded. Current usage: 10000, Monthly limit: 10000\"\n }\n}"},{"id":"2fe58542-5d50-4012-8cd8-8ed08c6517f5","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/stats/usage"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c7397952-9787-4812-800a-ff596b0c8e22"}],"id":"75187eec-25a7-463a-a52f-f105d535c08c","_postman_id":"75187eec-25a7-463a-a52f-f105d535c08c","description":""},{"name":"videos","item":[{"name":"timeline","item":[{"name":"Get timeline statistics for one or multiple videos","id":"8650d2d4-cf34-4019-8c79-e966f5cc97f0","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/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","description":"

Returns timeline data with metrics grouped by segments and dates.

\n

Note: This endpoint counts towards your monthly API usage limits. Check /stats/usage to monitor your current usage.

\n

Restrictions:

\n
    \n
  • Date range cannot exceed 1 month
    • \n
  • Maximum 5 videos per request
    • \n
  • Maximum 5 metrics per request
    • \n
  • Maximum 5 filters per request (across all filter types: browsers, conversions, devices, geo, url_params)
    • \n
  • Only Enterprise tier customers can query multiple metrics, videos, or filters at once
    • \n
\n

Available Filter Types:

\n
    \n
  • filter.browsers - Filter by browser types
    • \n
  • filter.conversions - Filter by conversion GUIDs
    • \n
  • filter.devices - Filter by device types
    • \n
  • filter.geo - Filter by country codes (ISO 3166-1 alpha-3)
    • \n
  • filter.url_params.<param> - Filter by URL parameter values
    • \n
\n","urlObject":{"path":["stats","videos","timeline"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"

Comma-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.

\n","type":"text/plain"},"key":"metrics","value":"plays,impressions,conversions"},{"description":{"content":"

Start 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":"

Segment to filter by

\n","type":"text/plain"},"key":"segment","value":"segment.all"},{"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.

\n

Pattern: filter.url_params.{paramName}=value1,value2

\n

Examples:

\n
    \n
  • filter.url_params.affiliates=aff1,aff2 - Filter by affiliates parameter
    • \n
  • filter.url_params.utm_source=google,facebook - Filter by utm_source parameter
    • \n
  • filter.url_params.campaign=summer,winter - Filter by campaign parameter
    • \n
\n

You 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":"da7a175f-8791-43b5-b152-d3e60fe760fe","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","host":["https://api.vidalytics.com/public/v1"],"path":["stats","videos","timeline"],"query":[{"description":"Comma-separated list of video GUIDs to retrieve timeline for (max 5)","key":"videoGuids","value":"testvid1,testvid2"},{"description":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.","key":"metrics","value":"plays,impressions,conversions"},{"description":"Start date for the timeline range","key":"dateFrom","value":"2025-01-01"},{"description":"End date for the timeline range (max 1 month from dateFrom)","key":"dateTo","value":"2025-01-31"},{"description":"Segment to filter by","key":"segment","value":"segment.all"},{"description":"Comma-separated list of browsers to filter by","key":"filter.browsers","value":"chrome,safari,firefox"},{"description":"Comma-separated list of conversion GUIDs to filter by","key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":"Comma-separated list of devices to filter by","key":"filter.devices","value":"desktop,mobile"},{"description":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)","key":"filter.geo","value":"USA,GBR,CAN"},{"description":"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.\n\n**Pattern:** `filter.url_params.{paramName}=value1,value2`\n\n**Examples:**\n- `filter.url_params.affiliates=aff1,aff2` - Filter by affiliates parameter\n- `filter.url_params.utm_source=google,facebook` - Filter by utm_source parameter\n- `filter.url_params.campaign=summer,winter` - Filter by campaign parameter\n\nYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.\n","key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}]}},"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 {\n \"segment\": \"United States\",\n \"data\": [\n {\n \"date\": \"2025-01-01 00:00:00\",\n \"data\": [\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 748\n }\n },\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 9480\n }\n }\n ]\n },\n {\n \"date\": \"2025-01-01 00:00:00\",\n \"data\": [\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 87\n }\n },\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 3619\n }\n }\n ]\n }\n ]\n },\n {\n \"segment\": \"United States\",\n \"data\": [\n {\n \"date\": \"2025-01-01 00:00:00\",\n \"data\": [\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 2351\n }\n },\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 281,\n \"key_1\": 6543,\n \"key_2\": 5262\n }\n }\n ]\n },\n {\n \"date\": \"2025-01-01 00:00:00\",\n \"data\": [\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 4245,\n \"key_1\": 7514,\n \"key_2\": 8591,\n \"key_3\": 5028\n }\n },\n {\n \"videoGuid\": \"testvid1\",\n \"metrics\": {\n \"key_0\": 3496,\n \"key_1\": 3055,\n \"key_2\": 8916\n }\n }\n ]\n }\n ]\n }\n ]\n }\n}"},{"id":"dfbed94b-0337-43ac-93f9-2a283a3f08fc","name":"Bad request (invalid parameters, date range exceeds 1 month, more than 5 videos/metrics/filters, or non-enterprise user requesting multiple metrics)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","host":["https://api.vidalytics.com/public/v1"],"path":["stats","videos","timeline"],"query":[{"description":"Comma-separated list of video GUIDs to retrieve timeline for (max 5)","key":"videoGuids","value":"testvid1,testvid2"},{"description":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.","key":"metrics","value":"plays,impressions,conversions"},{"description":"Start date for the timeline range","key":"dateFrom","value":"2025-01-01"},{"description":"End date for the timeline range (max 1 month from dateFrom)","key":"dateTo","value":"2025-01-31"},{"description":"Segment to filter by","key":"segment","value":"segment.all"},{"description":"Comma-separated list of browsers to filter by","key":"filter.browsers","value":"chrome,safari,firefox"},{"description":"Comma-separated list of conversion GUIDs to filter by","key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":"Comma-separated list of devices to filter by","key":"filter.devices","value":"desktop,mobile"},{"description":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)","key":"filter.geo","value":"USA,GBR,CAN"},{"description":"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.\n\n**Pattern:** `filter.url_params.{paramName}=value1,value2`\n\n**Examples:**\n- `filter.url_params.affiliates=aff1,aff2` - Filter by affiliates parameter\n- `filter.url_params.utm_source=google,facebook` - Filter by utm_source parameter\n- `filter.url_params.campaign=summer,winter` - Filter by campaign parameter\n\nYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.\n","key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"628ff204-49b2-4817-8226-14a37a42b620","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","host":["https://api.vidalytics.com/public/v1"],"path":["stats","videos","timeline"],"query":[{"description":"Comma-separated list of video GUIDs to retrieve timeline for (max 5)","key":"videoGuids","value":"testvid1,testvid2"},{"description":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.","key":"metrics","value":"plays,impressions,conversions"},{"description":"Start date for the timeline range","key":"dateFrom","value":"2025-01-01"},{"description":"End date for the timeline range (max 1 month from dateFrom)","key":"dateTo","value":"2025-01-31"},{"description":"Segment to filter by","key":"segment","value":"segment.all"},{"description":"Comma-separated list of browsers to filter by","key":"filter.browsers","value":"chrome,safari,firefox"},{"description":"Comma-separated list of conversion GUIDs to filter by","key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":"Comma-separated list of devices to filter by","key":"filter.devices","value":"desktop,mobile"},{"description":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)","key":"filter.geo","value":"USA,GBR,CAN"},{"description":"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.\n\n**Pattern:** `filter.url_params.{paramName}=value1,value2`\n\n**Examples:**\n- `filter.url_params.affiliates=aff1,aff2` - Filter by affiliates parameter\n- `filter.url_params.utm_source=google,facebook` - Filter by utm_source parameter\n- `filter.url_params.campaign=summer,winter` - Filter by campaign parameter\n\nYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.\n","key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ac12caec-0728-4bca-a5bc-5de6596fb7f0","name":"Rate limit exceeded. This can occur in two scenarios:\n\n1. **Monthly limit reached with throttling active**: You've reached your monthly limit and are now restricted to a reduced hourly rate. The error message will indicate the hourly limit.\n2. **Hard limi","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","host":["https://api.vidalytics.com/public/v1"],"path":["stats","videos","timeline"],"query":[{"description":"Comma-separated list of video GUIDs to retrieve timeline for (max 5)","key":"videoGuids","value":"testvid1,testvid2"},{"description":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.","key":"metrics","value":"plays,impressions,conversions"},{"description":"Start date for the timeline range","key":"dateFrom","value":"2025-01-01"},{"description":"End date for the timeline range (max 1 month from dateFrom)","key":"dateTo","value":"2025-01-31"},{"description":"Segment to filter by","key":"segment","value":"segment.all"},{"description":"Comma-separated list of browsers to filter by","key":"filter.browsers","value":"chrome,safari,firefox"},{"description":"Comma-separated list of conversion GUIDs to filter by","key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":"Comma-separated list of devices to filter by","key":"filter.devices","value":"desktop,mobile"},{"description":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)","key":"filter.geo","value":"USA,GBR,CAN"},{"description":"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.\n\n**Pattern:** `filter.url_params.{paramName}=value1,value2`\n\n**Examples:**\n- `filter.url_params.affiliates=aff1,aff2` - Filter by affiliates parameter\n- `filter.url_params.utm_source=google,facebook` - Filter by utm_source parameter\n- `filter.url_params.campaign=summer,winter` - Filter by campaign parameter\n\nYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.\n","key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": false,\n \"error\": {\n \"code\": 429,\n \"message\": \"Limit exceeded. Current usage: 10000, Monthly limit: 10000\"\n }\n}"},{"id":"51d9799c-7655-4e8e-abb2-750cb1170257","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/stats/videos/timeline?videoGuids=testvid1,testvid2&metrics=plays,impressions,conversions&dateFrom=2025-01-01&dateTo=2025-01-31&segment=segment.all&filter.browsers=chrome,safari,firefox&filter.conversions=conv_guid1,conv_guid2&filter.devices=desktop,mobile&filter.geo=USA,GBR,CAN&filter.url_params.{paramName}=aff1,aff2,aff3","host":["https://api.vidalytics.com/public/v1"],"path":["stats","videos","timeline"],"query":[{"description":"Comma-separated list of video GUIDs to retrieve timeline for (max 5)","key":"videoGuids","value":"testvid1,testvid2"},{"description":"Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.","key":"metrics","value":"plays,impressions,conversions"},{"description":"Start date for the timeline range","key":"dateFrom","value":"2025-01-01"},{"description":"End date for the timeline range (max 1 month from dateFrom)","key":"dateTo","value":"2025-01-31"},{"description":"Segment to filter by","key":"segment","value":"segment.all"},{"description":"Comma-separated list of browsers to filter by","key":"filter.browsers","value":"chrome,safari,firefox"},{"description":"Comma-separated list of conversion GUIDs to filter by","key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":"Comma-separated list of devices to filter by","key":"filter.devices","value":"desktop,mobile"},{"description":"Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)","key":"filter.geo","value":"USA,GBR,CAN"},{"description":"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.\n\n**Pattern:** `filter.url_params.{paramName}=value1,value2`\n\n**Examples:**\n- `filter.url_params.affiliates=aff1,aff2` - Filter by affiliates parameter\n- `filter.url_params.utm_source=google,facebook` - Filter by utm_source parameter\n- `filter.url_params.campaign=summer,winter` - Filter by campaign parameter\n\nYou can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.\n","key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8650d2d4-cf34-4019-8c79-e966f5cc97f0"}],"id":"d3bc4493-fb9b-4150-a6f3-c165e7dc5dde","_postman_id":"d3bc4493-fb9b-4150-a6f3-c165e7dc5dde","description":""}],"id":"4f5059a5-5528-48a2-947e-505cb7c5e139","_postman_id":"4f5059a5-5528-48a2-947e-505cb7c5e139","description":""}],"id":"589780a2-4007-4d87-93cc-475d88755a55","_postman_id":"589780a2-4007-4d87-93cc-475d88755a55","description":""},{"name":"folder","item":[{"name":"{folder_id}","item":[{"name":"Returns a folder by ID","id":"e17c1ac5-6a54-4b7d-8700-b9e2bcf28620","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/folder/:folder_id","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"d8eb1d08-2bf1-49e1-acbe-dbcaa1a1f056","description":{"content":"

The ID of the folder to retrieve

\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"43601d20-93d7-46a1-9c79-527623c7780b","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":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"The ID of the folder to retrieve"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"dateCreated\": \"2021-06-28T06:39:25.228Z\",\n \"videoCount\": 6403,\n \"parentFolderId\": \"string\"\n}"},{"id":"cfffb215-1021-491e-8a03-c2b5776d665b","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"The ID of the folder to retrieve"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"3d467f62-ee18-4bd4-a225-8fb721e15f6e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"The ID of the folder to retrieve"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"3ba7c9b8-0ffe-49f3-839a-9cb4876041f2","name":"Folder not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"The ID of the folder to retrieve"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e17c1ac5-6a54-4b7d-8700-b9e2bcf28620"},{"name":"Update folder details","id":"bceadb7d-44da-4e3c-b274-3b20d2c1d942","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":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder/:folder_id","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"e5a8dbdb-82f9-4655-9b7d-9ece253f4376","description":{"content":"

ID of the folder

\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"5ed804d4-4b9e-49ec-afa1-dcc2e55d8cc6","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":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"dateCreated\": \"2021-06-28T06:39:25.228Z\",\n \"videoCount\": 6403,\n \"parentFolderId\": \"string\"\n}"},{"id":"f274666b-2070-4681-af78-6d120192dbda","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"8a42e59c-2e15-41a0-a39b-3f0b4743e7e4","name":"Folder not found","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bceadb7d-44da-4e3c-b274-3b20d2c1d942"},{"name":"Delete a folder","id":"0a1798b5-d64e-42ac-99d1-8e52aab328c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://api.vidalytics.com/public/v1/folder/:folder_id","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"6e726f7a-ee16-4776-a615-56d87cd7608c","description":{"content":"

ID of the folder

\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"a8bbb727-551f-4bae-960d-8b5e886efd34","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"1a3a523c-e4e2-4671-b2c1-244edde0463e","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"75346228-2188-4700-8ff9-9e69e2e5f0fb","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"c8b436b8-d1ab-43ed-8b1e-fe2351fcf4d3","name":"Folder not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":{"raw":"https://api.vidalytics.com/public/v1/folder/:folder_id","host":["https://api.vidalytics.com/public/v1"],"path":["folder",":folder_id"],"variable":[{"key":"folder_id","value":"string","description":"ID of the folder"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0a1798b5-d64e-42ac-99d1-8e52aab328c1"}],"id":"72c59d82-48da-41a3-ac28-9ed7a0c300b3","_postman_id":"72c59d82-48da-41a3-ac28-9ed7a0c300b3","description":""},{"name":"Returns a list of folders","id":"78e3ccea-b35a-4f48-82f1-af4b8b866ee1","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/folder","urlObject":{"path":["folder"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"b31aa154-ddc6-46e9-92b6-a99d5259d4a8","name":"A list of folder entities","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/folder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"dateCreated\": \"2016-01-22T14:39:06.756Z\",\n \"videoCount\": 7706,\n \"parentFolderId\": \"string\"\n },\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"dateCreated\": \"2015-04-07T01:54:24.574Z\",\n \"videoCount\": 6855,\n \"parentFolderId\": \"string\"\n }\n]"},{"id":"8c743a99-89d1-4a53-8788-347109c24679","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"bb867f56-3480-478a-9a5a-4d0c4740705a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"78e3ccea-b35a-4f48-82f1-af4b8b866ee1"},{"name":"Creates a new folder","id":"66b89b93-039c-4381-a0ad-5e163429f15f","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":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"new-folder\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder","urlObject":{"path":["folder"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"2ae78538-29c6-4886-9289-d0887a69acab","name":"The created folder entity","originalRequest":{"method":"POST","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":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"new-folder\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"name\": \"string\",\n \"dateCreated\": \"2021-06-28T06:39:25.228Z\",\n \"videoCount\": 6403,\n \"parentFolderId\": \"string\"\n}"},{"id":"a3482fbc-5abb-4287-b854-c0cd822a5d21","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"new-folder\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6d4bfdf2-c172-4522-afdc-90eb8e9a00c2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":""}],"body":{"mode":"raw","raw":"{\n \"name\": \"new-folder\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"66b89b93-039c-4381-a0ad-5e163429f15f"}],"id":"ca4d3706-1e7f-436f-900d-9f6e0e1d9f20","_postman_id":"ca4d3706-1e7f-436f-900d-9f6e0e1d9f20","description":""},{"name":"settings-templates","item":[{"name":"List settings templates","id":"bb7a8a26-5655-48dc-a51c-ce3797f9d79c","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/settings-templates","urlObject":{"path":["settings-templates"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb7a8a26-5655-48dc-a51c-ce3797f9d79c"},{"name":"Apply template to video","id":"b7c05f56-8cf7-4a65-a965-25c3b39c9112","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 \"videoGuid\": \"abc123\",\n \"republish\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/settings-templates/:template_id/apply","urlObject":{"path":["settings-templates",":template_id","apply"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"3638f7e9-6d76-4d94-9db0-9d508f5e1fe6","description":{"content":"

The ID of the settings template

\n","type":"text/plain"},"type":"any","value":"string","key":"template_id"}]}},"response":[],"_postman_id":"b7c05f56-8cf7-4a65-a965-25c3b39c9112"}],"id":"30f8c0b0-08e8-4298-9c98-a0c385a400a6","_postman_id":"30f8c0b0-08e8-4298-9c98-a0c385a400a6","description":""}],"variable":[{"key":"baseUrl","value":"https://api.vidalytics.com/public/v1"}]}