{"info":{"_postman_id":"8d084dd7-174a-4539-91ef-a3a7497a05ef","name":"Vidalytics Public API","description":"<html><head></head><body><p>Vidalytics Public API</p>\n<h2 id=\"usage-limits\">Usage Limits</h2>\n<p>Some endpoints are subject to rate limits — these are noted in their respective documentation.</p>\n<p>When you reach your <strong>monthly usage limit</strong> for a rate-limited endpoint, the following applies:</p>\n<ol>\n<li><strong>Normal Operation</strong> — Requests count toward your monthly quota as usual.</li>\n<li><strong>Monthly Limit Reached</strong> — You can continue making requests, but at a reduced rate.</li>\n<li><strong>Throttle Exceeded</strong> — If you exceed the hourly throttle limit, the API will return a <strong>429 Too Many Requests</strong> error.</li>\n</ol>\n<p>You can check your current usage and remaining quota at any time using the <a href=\"#\"><code>/stats/usage</code></a> endpoint.</p>\n<h2 id=\"authentication\">Authentication</h2>\n<p>Send your API key verbatim as the <code>X-API-Key</code> header — no <code>Bearer</code> prefix. Each key is bound to one workspace (or, for an account-scoped key, to the whole account). Generate one from the dashboard's API settings page.</p>\n</body></html>","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":"2026-04-30T16:16:30.000Z"},"item":[{"name":"video","item":[{"name":"{video_id}","item":[{"name":"settings","item":[{"name":"Get video settings","id":"29673b8e-6d92-4d16-b169-4a101dc06270","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","description":"<p>Returns the video's current (published) settings as a flat snake_case object. Responds 404 if the video does not exist.</p>\n","urlObject":{"path":["video",":video_id","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"85a99849-002d-4112-8953-6cb23fef356d","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"29673b8e-6d92-4d16-b169-4a101dc06270"},{"name":"Update video settings","id":"590dd5f7-70dc-4f53-9510-23a03aea3402","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"video_title\": \"My updated title\",\n\n  \"playback_autoplay_enabled\": false,\n  \"playback_autoplay_loop_enabled\": false,\n  \"playback_autoplay_loop_to\": 0,\n  \"playback_autoplay_mobile\": false,\n  \"playback_autoplay_only_muted\": false,\n  \"playback_no_pause\": false,\n  \"playback_on_end\": \"pause\",\n  \"playback_resume\": true,\n  \"playback_smart_pause\": false,\n  \"playback_smart_pause_resume\": false,\n  \"playback_skip_and_rewind_with_keyboard\": true,\n\n  \"color_foreground\": \"#3974ff\",\n  \"color_background\": \"#000000\",\n  \"color_force\": false,\n\n  \"control_bar_fullscreen_show\": true,\n  \"control_bar_fullscreen_custom_default_enabled\": false,\n  \"control_bar_fullscreen_custom_mobile_enabled\": false,\n  \"control_bar_fullscreen_minimize_on_pause\": false,\n  \"control_bar_fullscreen_expand_on_play\": false,\n  \"control_bar_fullscreen_allow_scroll\": false,\n  \"control_bar_play_show\": true,\n  \"control_bar_pip_show\": false,\n  \"control_bar_pip_auto_mode\": false,\n  \"control_bar_rewind_show\": true,\n  \"control_bar_seek_bar_show\": true,\n  \"control_bar_seek_bar_position\": \"aboveControls\",\n  \"control_bar_seek_bar_mode\": \"standard\",\n  \"control_bar_seek_bar_show_to_returning_viewers\": false,\n  \"control_bar_seek_bar_rapid_engage_desktop_speed\": 2,\n  \"control_bar_seek_bar_rapid_engage_mobile_speed\": 2,\n  \"control_bar_seek_bar_storybar_style\": \"storiesGrid\",\n  \"control_bar_seek_bar_storybar_parts\": [{\"time\": 0, \"title\": \"Intro\"}, {\"time\": 30, \"title\": \"Main\"}],\n  \"control_bar_speed_control_show\": true,\n  \"control_bar_quality_control_show\": true,\n  \"control_bar_volume_show\": true,\n  \"control_bar_always_show\": false,\n  \"control_bar_playback_timer_show\": true,\n  \"control_bar_allow_seek_navigation\": true,\n  \"control_bar_hide_on_pause\": false,\n  \"control_bar_progress_line_show\": true,\n  \"control_bar_progress_line_position\": \"bottomEdge\",\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\": 5,\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","description":"<p>Partially updates a video's settings. Only the fields present in the body are changed; the rest keep their current value. The change is saved immediately — a GET right after reflects it — but the live embedded player only picks it up after POST /video/{video_id}/publish re-publishes the video.</p>\n<h3 id=\"allowed-values\">Allowed values</h3>\n<p>These fields take a fixed set of string values; anything else is rejected with <strong>400 Bad Request</strong>.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Values</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>playback_on_end</code></td>\n<td><code>pause</code>, <code>redirect</code>, <code>replay</code>, <code>display_thumbnail</code></td>\n</tr>\n<tr>\n<td><code>control_bar_seek_bar_position</code></td>\n<td><code>aboveControls</code> — seek bar above the control buttons<br /><code>belowControls</code> — seek bar below the control buttons</td>\n</tr>\n<tr>\n<td><code>control_bar_seek_bar_mode</code></td>\n<td><code>standard</code> — a regular progress bar that moves at a steady pace<br /><code>rapidEngage</code> — starts fast, then slows down, so the video feels shorter (speed: <code>control_bar_seek_bar_rapid_engage_desktop_speed</code> / <code>control_bar_seek_bar_rapid_engage_mobile_speed</code>, 0–2)<br /><code>storybar</code> — splits the video into story-like parts (see <code>control_bar_seek_bar_storybar_parts</code>); the dashboard offers it only with the <code>sleek</code> theme</td>\n</tr>\n<tr>\n<td><code>control_bar_seek_bar_storybar_style</code></td>\n<td><code>storiesGrid</code> — all parts shown at equal width (story-style)<br /><code>stepByStep</code> — reveals one part at a time</td>\n</tr>\n<tr>\n<td><code>control_bar_progress_line_position</code></td>\n<td><code>topEdge</code> — along the top edge of the player<br /><code>bottomEdge</code> — along the bottom edge of the player</td>\n</tr>\n<tr>\n<td><code>control_bar_progress_line_visibility</code></td>\n<td><code>always</code> — always visible<br /><code>whenControlsVisible</code> — only while the control bar is visible<br /><code>whenControlsHidden</code> — only while the control bar is hidden</td>\n</tr>\n<tr>\n<td><code>overlay_unmute_type</code></td>\n<td><code>box</code> — \"Front &amp; Center\": a box in the middle of the player<br /><code>button</code> — \"Classy in the Corner\": a small button in the corner<br /><code>overlay</code> — \"Loud &amp; in Your Face\": a full-player overlay<br /><code>none</code> — no unmute prompt</td>\n</tr>\n<tr>\n<td><code>player_startup_quality</code></td>\n<td><code>auto</code> — picked automatically to match the viewer's internet speed<br /><code>low</code> — fastest, 360p<br /><code>medium</code> — 720p in most cases<br /><code>high</code> — 1080p<br />The player may still adjust the quality to the viewer's connection.</td>\n</tr>\n<tr>\n<td><code>theme_name</code></td>\n<td><code>classic</code>, <code>sleek</code></td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"path":["video",":video_id","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"42013654-19c0-46af-8fce-55a656436aae","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"590dd5f7-70dc-4f53-9510-23a03aea3402"}],"id":"acec19e0-bae8-48d3-8975-d4fa013813a4","_postman_id":"acec19e0-bae8-48d3-8975-d4fa013813a4","description":""},{"name":"publish","item":[{"name":"Publish video","id":"93c75474-a775-4b84-aec3-e5dae98ef3c0","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","description":"<p>Applies the video's pending settings changes and enqueues the video for republishing; the response returns before republishing finishes, so the live embed updates shortly after, not instantly. Responds 404 if the video does not exist, or if it has no embed code yet.</p>\n","urlObject":{"path":["video",":video_id","publish"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c4edc14b-a161-45a4-8fe3-24ce25250367","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"93c75474-a775-4b84-aec3-e5dae98ef3c0"}],"id":"3cc5f080-2189-46b1-8949-e22c525800fa","_postman_id":"3cc5f080-2189-46b1-8949-e22c525800fa","description":""},{"name":"duplicate","item":[{"name":"Duplicate video","id":"42c05b5a-8a5d-4a97-b8b8-6cd9c27b751e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{apiKey}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","description":"<p>Creates a copy of the video with all settings, thumbnails, CTAs, triggers, playgates, conversions and closed captions. The duplicate is placed in the same folder as the source and published immediately.</p>\n","urlObject":{"path":["video",":video_id","duplicate"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"be91525b-2742-402b-8d01-f71eb9886156","description":{"content":"<p>The GUID of the video to duplicate</p>\n","type":"text/plain"},"type":"any","value":"","key":"video_id"}]}},"response":[{"id":"3d2147eb-8198-4724-a4ab-c823fac748f3","name":"Video duplicated successfully","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id","duplicate"],"variable":[{"key":"video_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": true,\n  \"content\": {\n    \"data\": {\n      \"id\": \"saQ9pDKsbejs0weH\",\n      \"title\": \"My Video Duplicate\",\n      \"date_created\": \"2026-05-01 12:00:00\",\n      \"folder_id\": \"f0lder-guid-here\",\n      \"embedGuid\": \"embed-guid-here\"\n    }\n  }\n}"},{"id":"5f17cfc6-bc9e-4605-8b2f-03e36dcd5f87","name":"Video not found","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video/:video_id/duplicate","host":["https://api.vidalytics.com/public/v1"],"path":["video",":video_id","duplicate"],"variable":[{"key":"video_id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n  \"status\": false,\n  \"error\": {\n    \"code\": 404,\n    \"message\": \"Video \\\"a1b2c3d4\\\" not found in your account.\"\n  }\n}"}],"_postman_id":"42c05b5a-8a5d-4a97-b8b8-6cd9c27b751e"}],"id":"ff4095dd-1bb0-4353-a8c1-1c0ccee28762","_postman_id":"ff4095dd-1bb0-4353-a8c1-1c0ccee28762","description":""},{"name":"thumbnail","item":[{"name":"pause-screen","item":[{"name":"List pause screens","id":"49f700a9-31af-4b7c-9edf-b812057f48c4","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","description":"<p>Returns every pause screen configured on a video, each with its GUID and its time_from/time_to window in seconds.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"2b3ed4cc-4e2a-471d-9852-3a59a2073306","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"49f700a9-31af-4b7c-9edf-b812057f48c4"},{"name":"Upload pause screen","id":"1a92163e-1462-426e-9938-f807b942b442","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":"<p>Binary content of the pause screen image</p>\n","value":null},{"key":"time_from","value":"10","type":"text","description":"<p>Start time in seconds</p>\n"},{"key":"time_to","value":"20","type":"text","description":"<p>End time in seconds</p>\n"}]},"url":"https://api.vidalytics.com/public/v1/video/:video_id/thumbnail/pause-screen","description":"<p>Adds a pause screen shown while playback is paused between time_from and time_to (seconds, both optional), from either an uploaded file (multipart) or a url (JSON body). Provide exactly one of file/url. time_from must not exceed time_to, and neither may exceed the video's duration.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"3b1f556f-a7a6-4495-859e-bf4bfb475396","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"1a92163e-1462-426e-9938-f807b942b442"},{"name":"Delete all pause screens","id":"8cff9c26-254a-40ae-893d-565cc1b310b6","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","description":"<p>Deletes every pause screen configured on the video. To remove a single one, use the per-GUID endpoint instead.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"8ff87749-3259-4a2e-ac61-bc1655303dd5","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"8cff9c26-254a-40ae-893d-565cc1b310b6"},{"name":"Update pause screen timing","id":"4100f0b3-41a6-4bab-bebc-140fa08b7a57","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":"<p>Update time_from and/or time_to for a specific pause screen. Accepts JSON body.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen",":thumbnail_guid"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"a0735fa6-3a2c-471f-ae4a-c017ca35a24e","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"fd739f6e-b62c-4adf-a57a-fd6e1283cc58","description":{"content":"<p>The GUID of the pause screen to update</p>\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"4100f0b3-41a6-4bab-bebc-140fa08b7a57"},{"name":"Delete pause screen by GUID","id":"c3f04e9f-714b-4908-aba4-00edde6402f6","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","description":"<p>Deletes one pause screen. Responds 404 if the video or the pause screen does not exist.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","pause-screen",":thumbnail_guid"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"3da8ecaf-b3b4-4081-a5e1-b61957263df6","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"6bdcc2d7-b602-41b1-9d25-5dcdff8175c7","description":{"content":"<p>The GUID of the pause screen thumbnail</p>\n","type":"text/plain"},"type":"any","value":"string","key":"thumbnail_guid"}]}},"response":[],"_postman_id":"c3f04e9f-714b-4908-aba4-00edde6402f6"}],"id":"6ccd221c-bc42-45ba-87f9-03c7a6f84afd","_postman_id":"6ccd221c-bc42-45ba-87f9-03c7a6f84afd","description":""},{"name":"Get thumbnails","id":"8bc72ff9-9c96-4585-be3b-a513f6167f5d","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","description":"<p>Returns the current desktop and mobile thumbnail configuration for a video (source image/video, time range, and generated URLs).</p>\n","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"30492949-ca1b-4ff8-9a4d-34a543723d84","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"8bc72ff9-9c96-4585-be3b-a513f6167f5d"},{"name":"Upload thumbnail","id":"b5965f23-0f22-4744-a5f2-0ef46305f929","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","description":"<p>Sets the video's desktop thumbnail from either an uploaded file (multipart) or a url (JSON body). Provide exactly one. A url is rejected with 400 if it resolves to a non-public/internal address (SSRF protection).</p>\n","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"fe43c54c-62b1-4b4a-8620-dd4b8464c19b","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"b5965f23-0f22-4744-a5f2-0ef46305f929"},{"name":"Update thumbnail config","id":"d46e9659-a453-4b01-8a1c-8e65f5541040","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","description":"<p>Configures how the desktop and mobile thumbnails are generated: a still frame from the video (thumbnail_default_from/_to, a time range in seconds) or a different source video (thumbnail_video_guid). Only the provided fields are changed.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","settings"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c830506e-f095-48d6-b0f8-73aaff9c3eed","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"d46e9659-a453-4b01-8a1c-8e65f5541040"},{"name":"Delete thumbnail","id":"5cc5c54e-ca34-4475-a027-770f8cac7a44","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","description":"<p>Removes the custom desktop thumbnail, reverting to the auto-generated default frame.</p>\n","urlObject":{"path":["video",":video_id","thumbnail"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"8f61d836-a330-48f5-b813-be14fdedb511","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"5cc5c54e-ca34-4475-a027-770f8cac7a44"},{"name":"Upload mobile thumbnail","id":"775f7715-6e33-4fdd-9ef1-ca9ea8582d04","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","description":"<p>Sets the video's mobile-only thumbnail from either an uploaded file (multipart) or a url (JSON body). Provide exactly one. A url is rejected with 400 if it resolves to a non-public/internal address (SSRF protection).</p>\n","urlObject":{"path":["video",":video_id","thumbnail","mobile"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"f9047a79-e081-49af-b5b2-ab8158758d54","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"775f7715-6e33-4fdd-9ef1-ca9ea8582d04"},{"name":"Delete mobile thumbnail","id":"6a1143a0-0b58-4eaa-9f4a-e26e078f840d","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","description":"<p>Removes the custom mobile thumbnail; the desktop thumbnail is then used on mobile too.</p>\n","urlObject":{"path":["video",":video_id","thumbnail","mobile"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"d1fc74bf-5586-40e0-86f6-e36d87bdc222","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"6a1143a0-0b58-4eaa-9f4a-e26e078f840d"}],"id":"cad58371-fed3-4947-a840-efaab81c6729","_postman_id":"cad58371-fed3-4947-a840-efaab81c6729","description":""},{"name":"call-to-action","item":[{"name":"List CTAs","id":"044a81a5-a711-4cd3-83bc-7a7da3e6cc42","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","description":"<p>Returns every call-to-action configured on a video.</p>\n","urlObject":{"path":["video",":video_id","call-to-action"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"8a0c7242-1418-402a-a0de-89453f864e69","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"044a81a5-a711-4cd3-83bc-7a7da3e6cc42"},{"name":"Create CTA","id":"019a84e7-05ab-4102-9225-8826c9935823","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:00\",\n    \"time_to\": \"0: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","description":"<p>Creates a new call-to-action on a video. time_from/time_to are colon-separated time strings (e.g. \"0:30\"), not integers.</p>\n","urlObject":{"path":["video",":video_id","call-to-action"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"7b70d6a6-4f77-47f0-9583-261519bb3747","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"019a84e7-05ab-4102-9225-8826c9935823"},{"name":"Update CTA","id":"b34df678-628a-4f27-b85b-4db96ce4f505","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:00\",\n    \"time_to\": \"0: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","description":"<p>Updates an existing call-to-action. Only the fields present in the body are changed; fields you omit keep their current value.</p>\n","urlObject":{"path":["video",":video_id","call-to-action",":cta_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"d3d1918e-a31f-431a-88b5-316c208f8ad2","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"bbb07dee-533b-4295-98e1-50a0eccd11f3","description":{"content":"<p>The ID of the CTA</p>\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"b34df678-628a-4f27-b85b-4db96ce4f505"},{"name":"Delete CTA","id":"cf869164-d543-411d-a608-965b1ccd98f0","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","description":"<p>Deletes a call-to-action by its GUID. Responds 404 if the video or the CTA does not exist.</p>\n","urlObject":{"path":["video",":video_id","call-to-action",":cta_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c81ef0a7-202b-4e75-95cc-b0ad492cded7","description":{"content":"<p>The ID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"b66baf4f-64d1-4011-9433-591519df61cb","description":{"content":"<p>The ID of the CTA</p>\n","type":"text/plain"},"type":"any","value":"string","key":"cta_id"}]}},"response":[],"_postman_id":"cf869164-d543-411d-a608-965b1ccd98f0"}],"id":"87f54c3f-4cfc-4ed9-9ee7-c5c5d3d93421","_postman_id":"87f54c3f-4cfc-4ed9-9ee7-c5c5d3d93421","description":""},{"name":"Get details on a single video by ID","id":"a7568946-2078-40b9-8aa8-ea774aa35236","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","description":"<p>Returns full details for one video by its GUID. Responds 404 if the video does not exist or was deleted.</p>\n","urlObject":{"path":["video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"ff94b15a-e50c-4bf3-a30d-6470ec61834f","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"44885b18-56ac-4348-abbb-9ce8adc9598d","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":"<API Key>"}],"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      \"embedGuid\": \"QwuRdTxz0l1HBGyA\"\n    }\n  }\n}"},{"id":"11a9b320-dc0b-47a4-9687-4c54deee2af0","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"a0236ffe-c7e7-48ef-be8f-b0ae4b2eaba1","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"de793240-dfb2-4ee6-b126-eaed7f8f779a","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"a7568946-2078-40b9-8aa8-ea774aa35236"},{"name":"Get video by embedGuid","id":"69fd0ff0-87c6-4ea7-9afc-3f9489e64c67","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?embedGuid={{embedGuid}}","description":"<p>Look up a single video by its embed code GUID.</p>\n","urlObject":{"path":["video"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"<p>The GUID of the embed code to look up the associated video.</p>\n","type":"text/plain"},"key":"embedGuid","value":"{{embedGuid}}"}],"variable":[]}},"response":[{"id":"9175e8c3-c18c-4621-8ce3-f320924d6499","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":"<API Key>"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video?embedGuid=QwuRdTxz0l1HBGyA","host":["https://api.vidalytics.com/public/v1"],"path":["video"],"query":[{"key":"embedGuid","value":"QwuRdTxz0l1HBGyA"}]}},"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\": \"QwuRdTxz0l1HBGyA\",\n      \"title\": \"My Video\",\n      \"date_created\": \"2023-02-22 11:01:52\",\n      \"last_published\": \"2023-02-22 11:04:37\",\n      \"status\": \"ready\",\n      \"views\": 0,\n      \"folder_id\": \"KBTe1Aumq1mPDu6G\",\n      \"thumbnail\": {\n        \"desktop\": \"https://quick.vidalytics.com/thumbs/desc/dasf0al.png\",\n        \"mobile\": null\n      },\n      \"url\": \"https://quick.vidalytics.com/video/88181/iv-mobile-on-square.mp4\",\n      \"embedGuid\": \"QwuRdTxz0l1HBGyA\"\n    }\n  }\n}"},{"id":"ebb7c330-d4ed-4b96-8570-44f74c0f13b6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video?embedGuid=QwuRdTxz0l1HBGyA","host":["https://api.vidalytics.com/public/v1"],"path":["video"],"query":[{"key":"embedGuid","value":"QwuRdTxz0l1HBGyA"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"23caf333-96d5-4c87-9cdd-34a58335bba8","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":{"raw":"https://api.vidalytics.com/public/v1/video?embedGuid=QwuRdTxz0l1HBGyA","host":["https://api.vidalytics.com/public/v1"],"path":["video"],"query":[{"key":"embedGuid","value":"QwuRdTxz0l1HBGyA"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"69fd0ff0-87c6-4ea7-9afc-3f9489e64c67"},{"name":"Update a video","id":"48ae7e7f-10e4-4901-96fd-93028f25c79a","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","description":"<p>Updates a video's title and/or folder. Only the fields present in the body are changed; omitted fields keep their current value. Set folder_id to an empty string to move the video to the root folder. Responds 404 if the video, or the target folder, does not exist.</p>\n","urlObject":{"path":["video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"95f7c76c-093e-4c12-ac43-bfffed1b7f80","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"d5943749-c151-4708-b603-c3ec39e2c0cc","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":"<API Key>"}],"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":"863a0859-563e-482b-b597-3fc15739649f","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":"<API Key>"}],"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":"1dfe6d09-d940-43be-b032-36250ed03d3d","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":"<API Key>"}],"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":"aac0e08a-2959-4824-8c24-89533ffb9835","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":"<API Key>"}],"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":"48ae7e7f-10e4-4901-96fd-93028f25c79a"},{"name":"Delete a video","id":"80452d10-23d6-44b5-89b2-128694caeb68","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","description":"<p>Permanently deletes a video. Responds 404 if the video does not exist or was already deleted.</p>\n","urlObject":{"path":["video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"9523c8f3-e384-4387-a57d-86fae8609384","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"204eeffc-8ad6-43f1-8e6a-393100f369da","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":"<API Key>"}],"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":"60da118b-4eda-438b-bdbb-b9d382194803","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"418902dd-0f11-4664-9966-b0fd6459dfe4","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"e8173c87-df93-4785-b940-469775849424","name":"Video not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"75734759-e40f-4a1a-b1c5-6991e88d31ba","name":"Internal server error","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"80452d10-23d6-44b5-89b2-128694caeb68"}],"id":"97a99661-4463-4dca-9d78-cc81b3da3c7c","_postman_id":"97a99661-4463-4dca-9d78-cc81b3da3c7c","description":""},{"name":"upload","item":[{"name":"Upload a new video","id":"5d3ee440-44b1-4809-a943-cc920b03ae71","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":"<p>Title of the video</p>\n","key":"title","value":"my-test-name.avi","type":"text"},{"description":"<p>URL of the remote video file</p>\n","key":"url","value":"https://jsoncompare.org/LearningContainer/SampleFiles/Video/MP4/sample-mp4-file.mp4","type":"text"},{"description":"<p>Binary content of the video file being uploaded</p>\n","key":"file","type":"file","value":null}]},"url":"https://api.vidalytics.com/public/v1/video/upload","description":"<p>Uploads a new video, either from a remote url or as a multipart file. Provide exactly one of the two. title is optional; when omitted, the uploaded file's name is used.</p>\n","urlObject":{"path":["video","upload"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"5877ff1b-8c34-46df-879b-230ce62e2ec7","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":"<API Key>"}],"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":"902e92a8-49ec-4aa7-adfb-382f17ba6ebe","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":"<API Key>"}],"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":"4aabdac3-7595-4259-bfce-b43646891890","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":"<API Key>"}],"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":"5d3ee440-44b1-4809-a943-cc920b03ae71"}],"id":"7c7982c9-d9ed-4105-bda2-0b3e9306d05b","_postman_id":"7c7982c9-d9ed-4105-bda2-0b3e9306d05b","description":""},{"name":"Get a list of all videos","id":"4513e357-fe3f-4fae-8588-aa59623272b9","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?embedGuid={{embedGuid}}","description":"<p>Returns a list of all videos. Optionally filters by embed code GUID to retrieve a single matching video.</p>\n","urlObject":{"path":["video"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"<p>(optional) Filter by embed GUID.</p>\n","type":"text/plain"},"key":"embedGuid","value":"{{embedGuid}}"}],"variable":[]}},"response":[{"id":"88c2e498-5b85-450e-8bc3-96be59b021b7","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":"<API Key>"}],"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        \"embedGuid\": \"RpZOGcMe4Hpe1LI5\"\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        \"embedGuid\": \"RpZOGcMe4Hpe1LI5\"\n      }\n    ]\n  }\n}"},{"id":"1620ae6c-f681-41f5-af9f-73c6073099cb","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":"https://api.vidalytics.com/public/v1/video"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"11999186-1de5-4eca-9bee-47f4bfe81b9c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":"https://api.vidalytics.com/public/v1/video"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4513e357-fe3f-4fae-8588-aa59623272b9"}],"id":"f5170f7d-59be-4011-9534-afda3ba335a3","_postman_id":"f5170f7d-59be-4011-9534-afda3ba335a3","description":""},{"name":"embed","item":[{"name":"video","item":[{"name":"{video_id}","item":[{"name":"Get video's HTML embed code by ID","id":"97231c50-059f-4c5b-bd84-7433709ae236","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","description":"<p>Returns the ready-to-embed HTML snippet for a video. Responds 404 if the video does not exist.</p>\n","urlObject":{"path":["embed","video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"247e9ab5-17de-4379-96ec-b351588a095f","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"44bc431a-ef17-4537-9bbc-a430002956b0","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":"<API Key>"}],"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":"7f539a54-1e1a-4c33-92c4-25e3d5090fa5","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"07f9b903-8c51-4115-8339-5d32caedfdbb","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"e1b111b1-9982-4c75-9426-bd85bf88f2c5","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"97231c50-059f-4c5b-bd84-7433709ae236"}],"id":"e34907eb-8785-43fc-918f-8aad3cb5519c","_postman_id":"e34907eb-8785-43fc-918f-8aad3cb5519c","description":""}],"id":"bd1850dc-f29e-4a3b-89cc-87c885fb7df1","_postman_id":"bd1850dc-f29e-4a3b-89cc-87c885fb7df1","description":""}],"id":"d756277a-6965-4319-b4f6-3c15eb614c38","_postman_id":"d756277a-6965-4319-b4f6-3c15eb614c38","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":"d715e201-81c2-4b28-bd6e-ada08c7e8b47","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":"<p>Returns viewer drop-off statistics showing how many viewers remain watching at each second of the video.</p>\n<p><strong>Note:</strong> This endpoint counts towards your monthly API usage limits. Check <code>/stats/usage</code> to monitor your current usage.</p>\n","urlObject":{"path":["stats","video",":video_id","drop-off"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"<p>date from for filter</p>\n","type":"text/plain"},"key":"dateFrom","value":"2020-01-01"},{"description":{"content":"<p>date to for filter</p>\n","type":"text/plain"},"key":"dateTo","value":"2023-02-01"}],"variable":[{"id":"c88b38b2-a357-43e5-9b5d-ce4c58d2346f","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"4b0f0e53-801f-4a82-8a78-7466dfcdd5f9","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":"<API Key>"}],"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":"6da20023-64b2-48c9-ab50-7b6d82a9fb84","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"04eead31-f6f9-4134-af12-d7ad4669e05a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"105d3d1a-e9b3-499b-add3-2295b8f946f4","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":"<API Key>"}],"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":"d715e201-81c2-4b28-bd6e-ada08c7e8b47"}],"id":"89d17252-e5e5-4415-9b98-978112b33dd1","_postman_id":"89d17252-e5e5-4415-9b98-978112b33dd1","description":""},{"name":"live-metrics","item":[{"name":"Get live metrics for a single video","id":"4d2720f0-bebd-46af-a318-8146a86072db","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":"<p>Returns real-time metrics for the specified video, such as current viewers watching.</p>\n<p><strong>Note:</strong> This endpoint is only available to Enterprise customers.</p>\n","urlObject":{"path":["stats","video",":video_id","live-metrics"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"c562ec47-e220-487e-8fef-e5f73066d9a3","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"73aa7b9b-9af7-48b2-90f1-1893150591ea","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":"<API Key>"}],"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":"7d51dff3-8e66-4454-b3bc-81e757bd17ba","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"33e0e5b0-a56c-47a4-ad0a-27f5aff84a0a","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"a90beeff-a3cb-4edb-b0af-56e68e6fcc1f","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"fbd1e4e5-1087-4253-8edd-13f03a18953b","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"4d2720f0-bebd-46af-a318-8146a86072db"}],"id":"0252f7a4-ce76-43eb-97ee-b4376df6e47e","_postman_id":"0252f7a4-ce76-43eb-97ee-b4376df6e47e","description":""},{"name":"Get total statistics for a single video by ID","id":"bdc9d18e-6c00-4859-b92a-6c449a5f1b35","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":"<p>Returns total statistics for the specified video within the given date range.</p>\n<p><strong>Note:</strong> This endpoint counts towards your monthly API usage limits. Check <code>/stats/usage</code> to monitor your current usage.</p>\n","urlObject":{"path":["stats","video",":video_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"<p>date from for filter</p>\n","type":"text/plain"},"key":"dateFrom","value":"2020-01-01"},{"description":{"content":"<p>date to for filter</p>\n","type":"text/plain"},"key":"dateTo","value":"2023-02-01"}],"variable":[{"id":"e2051ebe-55ab-4e03-9393-665d840a8c44","description":{"content":"<p>The ID of the video to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[{"id":"21de6fb2-3254-4195-a9fd-607fec2e3819","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":"<API Key>"}],"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":"95599e8a-c17e-4d46-9d5c-a58aefc89400","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"5b98347a-0fc4-4a99-84b1-26a4e569baae","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"71054f60-b085-4aaf-8a21-38f8eb76d41b","name":"Video not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"fcd7b60e-aad5-41d6-a99a-c313a7bcc5f3","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":"<API Key>"}],"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":"bdc9d18e-6c00-4859-b92a-6c449a5f1b35"}],"id":"5c059a68-3673-409c-bfca-2555d22d3209","_postman_id":"5c059a68-3673-409c-bfca-2555d22d3209","description":""}],"id":"9daaf9ea-b707-4b43-880e-c5b64a28d77e","_postman_id":"9daaf9ea-b707-4b43-880e-c5b64a28d77e","description":""},{"name":"usage","item":[{"name":"Get current API usage limits","id":"d496859f-9773-42d1-9c25-bcd627b9cc9a","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":"<p>Returns the current API usage, including monthly limit, current usage, and remaining requests.</p>\n<p><strong>Usage Information:</strong></p>\n<ul>\n<li><code>monthly_limit</code>: Maximum number of API requests allowed per billing period (null means unlimited)</li>\n<li><code>current_usage</code>: Number of API requests made in the current billing period</li>\n<li><code>remaining</code>: Number of requests remaining (null if unlimited)</li>\n</ul>\n","urlObject":{"path":["stats","usage"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"31a6cfaa-0d7d-49be-aa83-084881d33801","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":"<API Key>"}],"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":"e13b1730-cd74-4930-b4a3-7beeb31eaeb9","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":"https://api.vidalytics.com/public/v1/stats/usage"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b6798405-1429-417f-b940-552df939562d","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":"<API Key>"}],"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":"a578341f-9bb5-4af6-844c-97466c67e89e","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"d496859f-9773-42d1-9c25-bcd627b9cc9a"}],"id":"f4e20222-adff-45e4-9613-0b1eea3b4b58","_postman_id":"f4e20222-adff-45e4-9613-0b1eea3b4b58","description":""},{"name":"videos","item":[{"name":"timeline","item":[{"name":"Get timeline statistics for one or multiple videos","id":"fd37a386-85fd-49e3-9a12-b4a3191196ce","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&segmentParams=utm_medium&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":"<p>Returns timeline data with metrics grouped by segments and dates.</p>\n<p><strong>Note:</strong> This endpoint counts towards your monthly API usage limits. Check <code>/stats/usage</code> to monitor your current usage.</p>\n<p><strong>Restrictions:</strong></p>\n<ul>\n<li>Date range cannot exceed 1 month</li>\n<li>Maximum 5 videos per request</li>\n<li>Maximum 5 metrics per request</li>\n<li>Maximum 5 filters per request (across all filter types: browsers, conversions, devices, geo, url_params)</li>\n<li>Only Enterprise tier customers can query multiple metrics, videos, or filters at once</li>\n</ul>\n<p><strong>Available Filter Types:</strong></p>\n<ul>\n<li><code>filter.browsers</code> - Filter by browser types</li>\n<li><code>filter.conversions</code> - Filter by conversion GUIDs</li>\n<li><code>filter.devices</code> - Filter by device types</li>\n<li><code>filter.geo</code> - Filter by country codes (ISO 3166-1 alpha-3)</li>\n<li><code>filter.url_params.&lt;param&gt;</code> - Filter by URL parameter values</li>\n</ul>\n","urlObject":{"path":["stats","videos","timeline"],"host":["https://api.vidalytics.com/public/v1"],"query":[{"description":{"content":"<p>Comma-separated list of video GUIDs to retrieve timeline for (max 5)</p>\n","type":"text/plain"},"key":"videoGuids","value":"testvid1,testvid2"},{"description":{"content":"<p>Comma-separated list of metrics to include. Max 5 metrics allowed for Enterprise tier customers.\n<strong>Available metrics:</strong></p>\n<ul>\n<li>plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.</li>\n<li>unmute_plays – Amount of users who played the video on mute.</li>\n<li>play_rate – The percentage of unique viewers who have the video played, including autoplays.</li>\n<li>impressions – The number of times the video player was loaded on a web page.</li>\n<li>unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).</li>\n<li>unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.</li>\n<li>avg_watched – The percentage of your video content that is being watched on average.</li>\n<li>conversions – The total number of conversion actions completed after watching this video, within your conversion window.</li>\n<li>conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.</li>\n<li>average_order – The average amount of money spent on orders completed after watching this video.</li>\n<li>opt_in_rate – Play Gate Submissions / Play Gate Displays.</li>\n<li>revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.</li>\n<li>revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.</li>\n<li>bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.</li>\n<li>cta_clicks – Total number of clicks on all CTAs in this video.</li>\n<li>redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.</li>\n</ul>\n","type":"text/plain"},"key":"metrics","value":"plays,impressions,conversions"},{"description":{"content":"<p>Start date for the timeline range</p>\n","type":"text/plain"},"key":"dateFrom","value":"2025-01-01"},{"description":{"content":"<p>End date for the timeline range (max 1 month from dateFrom)</p>\n","type":"text/plain"},"key":"dateTo","value":"2025-01-31"},{"description":{"content":"<p><strong>Available segments:</strong></p>\n<ul>\n<li>segment.all –  Return overall aggregated data</li>\n<li>segment.conversions – Segment data by conversions</li>\n<li>segment.geolocation – Segment data by viewers location</li>\n<li>segment.device – Segment data by device type</li>\n<li>segment.browser – Segment data by browser</li>\n<li>segment.url_params – Segment data by URL parameters</li>\n<li>segment.new-vs-returning – Segment data by new vs returning viewers</li>\n<li>segment.tags – Segment data by tags</li>\n<li>segment.muted-vs-unmuted – Segment data by muted vs unmuted</li>\n</ul>\n","type":"text/plain"},"key":"segment","value":"segment.all"},{"description":{"content":"<p>Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params</p>\n","type":"text/plain"},"key":"segmentParams","value":"utm_medium"},{"description":{"content":"<p>Comma-separated list of browsers to filter by</p>\n","type":"text/plain"},"key":"filter.browsers","value":"chrome,safari,firefox"},{"description":{"content":"<p>Comma-separated list of conversion GUIDs to filter by</p>\n","type":"text/plain"},"key":"filter.conversions","value":"conv_guid1,conv_guid2"},{"description":{"content":"<p>Comma-separated list of devices to filter by</p>\n","type":"text/plain"},"key":"filter.devices","value":"desktop,mobile"},{"description":{"content":"<p>Comma-separated list of alpha-3 country codes to filter by (ISO 3166-1 alpha-3)</p>\n","type":"text/plain"},"key":"filter.geo","value":"USA,GBR,CAN"},{"description":{"content":"<p>Filter by URL parameter values. This is a pattern parameter where <code>{paramName}</code> should be replaced with the actual URL parameter name you want to filter by.</p>\n<p><strong>Pattern:</strong> <code>filter.url_params.{paramName}=value1,value2</code></p>\n<p><strong>Examples:</strong></p>\n<ul>\n<li><code>filter.url_params.affiliates=aff1,aff2</code> - Filter by affiliates parameter</li>\n<li><code>filter.url_params.utm_source=google,facebook</code> - Filter by utm_source parameter</li>\n<li><code>filter.url_params.campaign=summer,winter</code> - Filter by campaign parameter</li>\n</ul>\n<p>You can use multiple url_params filters simultaneously (counting towards the max 5 filters total).\nValues are comma-separated for each parameter.</p>\n","type":"text/plain"},"key":"filter.url_params.{paramName}","value":"aff1,aff2,aff3"}],"variable":[]}},"response":[{"id":"161d190c-d8f3-4193-87cf-36364c6280b5","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":"<API Key>"}],"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&segmentParams=utm_medium&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.\n**Available metrics:**\n- plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.\n- unmute_plays – Amount of users who played the video on mute.\n- play_rate – The percentage of unique viewers who have the video played, including autoplays.\n- impressions – The number of times the video player was loaded on a web page.\n- unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).\n- unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.\n- avg_watched – The percentage of your video content that is being watched on average.\n- conversions – The total number of conversion actions completed after watching this video, within your conversion window.\n- conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.\n- average_order – The average amount of money spent on orders completed after watching this video.\n- opt_in_rate – Play Gate Submissions / Play Gate Displays.\n- revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.\n- revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.\n- bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.\n- cta_clicks – Total number of clicks on all CTAs in this video.\n- redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.\n","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":"**Available segments:**\n- segment.all –  Return overall aggregated data\n- segment.conversions – Segment data by conversions\n- segment.geolocation – Segment data by viewers location\n- segment.device – Segment data by device type\n- segment.browser – Segment data by browser\n- segment.url_params – Segment data by URL parameters\n- segment.new-vs-returning – Segment data by new vs returning viewers\n- segment.tags – Segment data by tags\n- segment.muted-vs-unmuted – Segment data by muted vs unmuted","key":"segment","value":"segment.all"},{"description":"Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params","key":"segmentParams","value":"utm_medium"},{"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":"dc6d2b1a-c835-4e13-9bb1-44b97eb6e45e","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":"<API Key>"}],"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&segmentParams=utm_medium&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.\n**Available metrics:**\n- plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.\n- unmute_plays – Amount of users who played the video on mute.\n- play_rate – The percentage of unique viewers who have the video played, including autoplays.\n- impressions – The number of times the video player was loaded on a web page.\n- unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).\n- unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.\n- avg_watched – The percentage of your video content that is being watched on average.\n- conversions – The total number of conversion actions completed after watching this video, within your conversion window.\n- conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.\n- average_order – The average amount of money spent on orders completed after watching this video.\n- opt_in_rate – Play Gate Submissions / Play Gate Displays.\n- revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.\n- revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.\n- bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.\n- cta_clicks – Total number of clicks on all CTAs in this video.\n- redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.\n","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":"**Available segments:**\n- segment.all –  Return overall aggregated data\n- segment.conversions – Segment data by conversions\n- segment.geolocation – Segment data by viewers location\n- segment.device – Segment data by device type\n- segment.browser – Segment data by browser\n- segment.url_params – Segment data by URL parameters\n- segment.new-vs-returning – Segment data by new vs returning viewers\n- segment.tags – Segment data by tags\n- segment.muted-vs-unmuted – Segment data by muted vs unmuted","key":"segment","value":"segment.all"},{"description":"Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params","key":"segmentParams","value":"utm_medium"},{"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":"b78b983b-9706-44ed-966c-c312234978bd","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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&segmentParams=utm_medium&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.\n**Available metrics:**\n- plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.\n- unmute_plays – Amount of users who played the video on mute.\n- play_rate – The percentage of unique viewers who have the video played, including autoplays.\n- impressions – The number of times the video player was loaded on a web page.\n- unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).\n- unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.\n- avg_watched – The percentage of your video content that is being watched on average.\n- conversions – The total number of conversion actions completed after watching this video, within your conversion window.\n- conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.\n- average_order – The average amount of money spent on orders completed after watching this video.\n- opt_in_rate – Play Gate Submissions / Play Gate Displays.\n- revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.\n- revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.\n- bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.\n- cta_clicks – Total number of clicks on all CTAs in this video.\n- redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.\n","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":"**Available segments:**\n- segment.all –  Return overall aggregated data\n- segment.conversions – Segment data by conversions\n- segment.geolocation – Segment data by viewers location\n- segment.device – Segment data by device type\n- segment.browser – Segment data by browser\n- segment.url_params – Segment data by URL parameters\n- segment.new-vs-returning – Segment data by new vs returning viewers\n- segment.tags – Segment data by tags\n- segment.muted-vs-unmuted – Segment data by muted vs unmuted","key":"segment","value":"segment.all"},{"description":"Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params","key":"segmentParams","value":"utm_medium"},{"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":"3c8771d5-1bdd-4fc5-b7c8-0512a7007bcd","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":"<API Key>"}],"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&segmentParams=utm_medium&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.\n**Available metrics:**\n- plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.\n- unmute_plays – Amount of users who played the video on mute.\n- play_rate – The percentage of unique viewers who have the video played, including autoplays.\n- impressions – The number of times the video player was loaded on a web page.\n- unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).\n- unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.\n- avg_watched – The percentage of your video content that is being watched on average.\n- conversions – The total number of conversion actions completed after watching this video, within your conversion window.\n- conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.\n- average_order – The average amount of money spent on orders completed after watching this video.\n- opt_in_rate – Play Gate Submissions / Play Gate Displays.\n- revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.\n- revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.\n- bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.\n- cta_clicks – Total number of clicks on all CTAs in this video.\n- redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.\n","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":"**Available segments:**\n- segment.all –  Return overall aggregated data\n- segment.conversions – Segment data by conversions\n- segment.geolocation – Segment data by viewers location\n- segment.device – Segment data by device type\n- segment.browser – Segment data by browser\n- segment.url_params – Segment data by URL parameters\n- segment.new-vs-returning – Segment data by new vs returning viewers\n- segment.tags – Segment data by tags\n- segment.muted-vs-unmuted – Segment data by muted vs unmuted","key":"segment","value":"segment.all"},{"description":"Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params","key":"segmentParams","value":"utm_medium"},{"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":"69445c14-ab5a-46a0-9e64-d578bd327342","name":"Internal server error","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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&segmentParams=utm_medium&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.\n**Available metrics:**\n- plays – The number of times the video has been watched, including autoplays, partial watches, and repeats.\n- unmute_plays – Amount of users who played the video on mute.\n- play_rate – The percentage of unique viewers who have the video played, including autoplays.\n- impressions – The number of times the video player was loaded on a web page.\n- unique_viewers – The number of viewers who watched the video at least once (excludes multiple views by the same person).\n- unmute_rate – The percentage of views that were unmuted, including unmutes with Smart Autoplay.\n- avg_watched – The percentage of your video content that is being watched on average.\n- conversions – The total number of conversion actions completed after watching this video, within your conversion window.\n- conversion_rate – The percentage of viewers who take a conversion action out of the total number of unique viewers.\n- average_order – The average amount of money spent on orders completed after watching this video.\n- opt_in_rate – Play Gate Submissions / Play Gate Displays.\n- revenue – Total spending on orders after watching this video, based on default values in Conversions settings or dynamic values passed via the Conversion code.\n- revenue_per_viewer – Total revenue generated from the video divided by the number of unique viewers.\n- bounce_rate – Percentage of plays with less than 5 seconds watch time and no CTA or Play Gate action.\n- cta_clicks – Total number of clicks on all CTAs in this video.\n- redirects – The number of views that were redirected at the end of the video. Tracked only when Countdown Timer / Redirect is enabled.\n","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":"**Available segments:**\n- segment.all –  Return overall aggregated data\n- segment.conversions – Segment data by conversions\n- segment.geolocation – Segment data by viewers location\n- segment.device – Segment data by device type\n- segment.browser – Segment data by browser\n- segment.url_params – Segment data by URL parameters\n- segment.new-vs-returning – Segment data by new vs returning viewers\n- segment.tags – Segment data by tags\n- segment.muted-vs-unmuted – Segment data by muted vs unmuted","key":"segment","value":"segment.all"},{"description":"Comma-separated list of additional segment parameters (max 2). Only used for segments that require extra params such as segment.url_params","key":"segmentParams","value":"utm_medium"},{"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":"fd37a386-85fd-49e3-9a12-b4a3191196ce"}],"id":"a1c3e49f-8d65-48eb-b18c-5c15e2286217","_postman_id":"a1c3e49f-8d65-48eb-b18c-5c15e2286217","description":""}],"id":"9f933e16-a2c5-49f1-8e7d-7715e975d203","_postman_id":"9f933e16-a2c5-49f1-8e7d-7715e975d203","description":""}],"id":"08459092-6f2d-46bc-8f6b-b2ebe3a3e84f","_postman_id":"08459092-6f2d-46bc-8f6b-b2ebe3a3e84f","description":""},{"name":"folder","item":[{"name":"{folder_id}","item":[{"name":"Returns a folder by ID","id":"43448038-303f-411f-bbe7-ffa206e36358","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","description":"<p>Returns a single folder by its GUID. Responds 404 if the folder does not exist.</p>\n","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"7a373525-ad66-4102-83fe-a59054df6246","description":{"content":"<p>The ID of the folder to retrieve</p>\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"c44547c4-e892-4392-bd8b-3838b1af9ee2","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":"<API Key>"}],"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":"8a54a98f-0db9-49f7-bba5-00bd0a8c86d7","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"b831e5ef-0424-4518-9b77-46e9a99cda9c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"5397a9ee-dbe8-4c34-ac31-f2b31df4be61","name":"Folder not found","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"43448038-303f-411f-bbe7-ffa206e36358"},{"name":"Update folder details","id":"5580b680-cd26-435c-a121-6900c8534b20","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  \"parentFolderId\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.vidalytics.com/public/v1/folder/:folder_id","description":"<p>Renames a folder, moves it, or both. name renames it and must be between 4 and 99 characters. A parentFolderId key moves the folder, with everything inside it, under that folder; null, an empty string or root moves it to the root. name is required unless parentFolderId is present; with both, the folder is moved first and then renamed. Responds 404 if the folder or the destination does not exist. A folder cannot be moved into itself or one of its own subfolders, and it cannot leave its workspace: for an account-scoped key, a destination in another workspace is a 400.</p>\n","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"f8c86ad0-135b-4a06-a3cd-8f92a4482add","description":{"content":"<p>ID of the folder</p>\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"035a380e-0c73-4fa1-9a11-b4b440e239dc","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":"<API Key>"}],"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":"3f671405-0845-4ce8-8db5-cf88f6fe1e26","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":"<API Key>"}],"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":"4e3bdefa-9a0b-4186-8d5f-6ed667451fe4","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":"<API Key>"}],"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":"5580b680-cd26-435c-a121-6900c8534b20"},{"name":"Delete a folder","id":"4dc2cfec-2863-4ebc-8c18-8892d4af9d12","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","description":"<p>Deletes a folder and, recursively, any empty child folders under it. Responds 400 if the folder (or a child folder) still contains videos — move or delete those videos first.</p>\n","urlObject":{"path":["folder",":folder_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"34836df7-cbc0-4f5e-80cd-1f7bc51dac8f","description":{"content":"<p>ID of the folder</p>\n","type":"text/plain"},"type":"any","value":"string","key":"folder_id"}]}},"response":[{"id":"97ad74a8-1278-452e-b1ab-d9bc06237177","name":"OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"0e39fb26-bf35-481f-af68-b67d2a2f8edf","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"6bfc116c-7a1c-449c-954a-0d641301efcc","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"63f52a5d-d852-47f8-98a2-2c84e80e9067","name":"Folder not found","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"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":"4dc2cfec-2863-4ebc-8c18-8892d4af9d12"}],"id":"52fe60c5-524c-47cb-b64c-2164b5e271ce","_postman_id":"52fe60c5-524c-47cb-b64c-2164b5e271ce","description":""},{"name":"Returns a list of folders","id":"0e1049ef-b2b2-446e-b600-3f37318d8406","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","description":"<p>Returns every folder on the account as a flat list — not nested under their parent.</p>\n","urlObject":{"path":["folder"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"13965ed7-f5e9-42b5-9cb3-ee662ac401c1","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":"<API Key>"}],"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":"ea9dfc0d-6b92-48ae-97e5-7f9ae476e08d","name":"Bad request","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"072fe28b-b97b-4d1b-9424-7f0245b109ad","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: apikey","key":"X-API-Key","value":"<API Key>"}],"url":"https://api.vidalytics.com/public/v1/folder"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0e1049ef-b2b2-446e-b600-3f37318d8406"},{"name":"Creates a new folder","id":"8bddddfe-be21-41d7-b9ba-14d6ec12c36c","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","description":"<p>Creates a folder at the account root. name must be between 3 and 100 characters.</p>\n","urlObject":{"path":["folder"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[{"id":"dbbeaaff-4df0-42be-accf-3bb962ed395e","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":"<API Key>"}],"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":"d6ad06fc-dd3a-4015-adca-baf686b0390a","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":"<API Key>"}],"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":"55c7c634-a365-4d34-8045-c447acbef0b4","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":"<API Key>"}],"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":"8bddddfe-be21-41d7-b9ba-14d6ec12c36c"}],"id":"dbb68651-8daa-42bc-9fa8-cc0300ece046","_postman_id":"dbb68651-8daa-42bc-9fa8-cc0300ece046","description":""},{"name":"settings-templates","item":[{"name":"List settings templates","id":"393c795e-b017-4834-a02d-1d587124069a","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","description":"<p>Returns every settings template configured on the account, so you can look up a template_id to apply.</p>\n","urlObject":{"path":["settings-templates"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"393c795e-b017-4834-a02d-1d587124069a"},{"name":"Apply template to video","id":"e797b241-3272-4c6a-97c0-69f79c60aa71","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","description":"<p>Synchronously applies the template to the specified video. Returns the result indicating success or failure. If republish=true, the video is also re-published after the template is applied.</p>\n","urlObject":{"path":["settings-templates",":template_id","apply"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"93dc12cf-dc98-457a-be19-03e124d82eb2","description":{"content":"<p>The ID of the settings template</p>\n","type":"text/plain"},"type":"any","value":"string","key":"template_id"}]}},"response":[],"_postman_id":"e797b241-3272-4c6a-97c0-69f79c60aa71"},{"name":"Create settings template","id":"943e1de3-78dd-46cd-a45a-a2bf3d0e0be8","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  \"name\": \"Sales page defaults\",\n  \"videoGuid\": \"abc123\",\n  \"description\": \"Optional description\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/settings-templates","description":"<p>Snapshots a video's current settings into a new reusable template. The template is created in the API key's home workspace.</p>\n","urlObject":{"path":["settings-templates"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[]}},"response":[],"_postman_id":"943e1de3-78dd-46cd-a45a-a2bf3d0e0be8"},{"name":"Update settings template","id":"73f1c27a-ea86-4647-bdd6-0371f08f3f96","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  \"name\": \"New name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/settings-templates/:template_id","description":"<p>Renames, re-describes or re-snapshots a template. Only fields present in the body are changed; pass videoGuid to re-snapshot from a video. An omitted or null description leaves it unchanged.</p>\n","urlObject":{"path":["settings-templates",":template_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"fd1264b0-ab2d-4a12-8f9d-9d63b4d1c5fc","description":{"content":"<p>The ID of the settings template</p>\n","type":"text/plain"},"type":"any","value":"string","key":"template_id"}]}},"response":[],"_postman_id":"73f1c27a-ea86-4647-bdd6-0371f08f3f96"},{"name":"Delete settings template","id":"9744e682-03b6-40e8-84ff-75499cbd0e05","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/settings-templates/:template_id","description":"<p>Deletes the template. It must live in the API key's home workspace.</p>\n","urlObject":{"path":["settings-templates",":template_id"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"20fe7f2d-afa2-47d3-9497-11d00ff43b62","description":{"content":"<p>The ID of the settings template</p>\n","type":"text/plain"},"type":"any","value":"string","key":"template_id"}]}},"response":[],"_postman_id":"9744e682-03b6-40e8-84ff-75499cbd0e05"}],"id":"e31f759c-b228-498e-b40b-2e0e35fae43f","_postman_id":"e31f759c-b228-498e-b40b-2e0e35fae43f","description":""},{"name":"captions","item":[{"name":"List caption tracks","id":"126b1fcc-bb2b-41fe-97f1-7010dca8744b","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/captions","description":"<p>Returns every caption track on the video (published, draft and AI-generated translations).</p>\n","urlObject":{"path":["video",":video_id","captions"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"08a6edab-017c-4f0b-a4de-773d0aeb3065","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"126b1fcc-bb2b-41fe-97f1-7010dca8744b"},{"name":"Get caption content","id":"fb4b74dd-d042-4226-b96e-3a2f06dfe7a4","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/captions/:language","description":"<p>Returns the stored text of one caption track, as WebVTT. Only a track shown as draft or active has text; a still-translating track returns 404.</p>\n","urlObject":{"path":["video",":video_id","captions",":language"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"bcdb2634-8e0f-4977-9300-dff70e2d5651","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"b0c21934-71a4-49ad-a1a1-20373e8e22ea","description":{"content":"<p>ISO language code of the caption track</p>\n","type":"text/plain"},"type":"any","value":"en","key":"language"}]}},"response":[],"_postman_id":"fb4b74dd-d042-4226-b96e-3a2f06dfe7a4"},{"name":"Add or replace a caption track","id":"dd1e5a94-fa62-4279-a859-dc1e9b839e18","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  \"language\": \"en\",\n  \"content\": \"WEBVTT\\n\\n00:00:00.000 --> 00:00:02.000\\nHello\",\n  \"format\": \"vtt\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/captions","description":"<p>Stores a caption track for a language from provided text. Saved to the video's draft; live after publish. An existing track for the same language is replaced.</p>\n","urlObject":{"path":["video",":video_id","captions"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"4b03eb4c-8ec6-423d-9f45-a1c855585366","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"dd1e5a94-fa62-4279-a859-dc1e9b839e18"},{"name":"Remove a caption language","id":"4e3ce87d-e0d7-4ffb-88d9-412dcca0a913","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/captions/:language","description":"<p>Removes a caption language. A draft-only track is dropped immediately; a published track is removed on the next publish when the video has an open draft, otherwise right away.</p>\n","urlObject":{"path":["video",":video_id","captions",":language"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"db639e2a-5625-45d4-9665-d82792b1052c","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"},{"id":"f286784c-c976-46d6-a361-b32fe15acb80","description":{"content":"<p>ISO language code of the caption track</p>\n","type":"text/plain"},"type":"any","value":"en","key":"language"}]}},"response":[],"_postman_id":"4e3ce87d-e0d7-4ffb-88d9-412dcca0a913"}],"id":"449c6793-ac10-4c6d-9970-43c6531c96be","_postman_id":"449c6793-ac10-4c6d-9970-43c6531c96be","description":""},{"name":"tags","item":[{"name":"List video tags","id":"01b79fb8-b608-4725-9ee9-d9a5e5a1996d","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/tags","description":"<p>Returns the video's tags and its custom variables.</p>\n<p>Each tag has a <code>type</code> of <code>time</code> or <code>callToAction</code>. A <code>callToAction</code> tag has <code>time</code> <code>00:00</code>.</p>\n","urlObject":{"path":["video",":video_id","tags"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"bdf84a07-468d-4068-bc48-d0f4e108736d","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"01b79fb8-b608-4725-9ee9-d9a5e5a1996d"},{"name":"Set video tags","id":"11980440-fdff-452b-bf60-2deddf39494d","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  \"tags\": [\n    { \"name\": \"Promo\", \"type\": \"time\", \"time\": \"01:30\" },\n    { \"name\": \"Clicked CTA\", \"type\": \"callToAction\" }\n  ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.vidalytics.com/public/v1/video/:video_id/tags","description":"<p>Replaces the video's full tag list (saved to draft; live after publish). tags is required: a request without it is rejected with 400. Send the full list every call; an explicit [] removes all <code>time</code> tags (<code>callToAction</code> tags stay — this endpoint does not remove them). customVariables is preserved when omitted; send [] to clear it.</p>\n<h3 id=\"tag-types\">Tag types</h3>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><code>type</code></th>\n<th>Fires when</th>\n<th>Fields</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>time</code></td>\n<td>the viewer reaches <code>time</code> in the video</td>\n<td><code>time</code> (<code>mm:ss</code> or <code>hh:mm:ss</code>, less than the video duration)</td>\n</tr>\n<tr>\n<td><code>callToAction</code></td>\n<td>the viewer clicks a CTA button</td>\n<td>no <code>time</code></td>\n</tr>\n</tbody>\n</table>\n</div><p>An existing tag cannot be switched between <code>time</code> and <code>callToAction</code> — the new type is ignored. A <code>callToAction</code> tag left out of the list is kept, not removed, so this endpoint cannot delete one.</p>\n","urlObject":{"path":["video",":video_id","tags"],"host":["https://api.vidalytics.com/public/v1"],"query":[],"variable":[{"id":"30664fcc-0422-4d90-87ce-846e45516232","description":{"content":"<p>The GUID of the video</p>\n","type":"text/plain"},"type":"any","value":"string","key":"video_id"}]}},"response":[],"_postman_id":"11980440-fdff-452b-bf60-2deddf39494d"}],"id":"f219e186-8861-48ce-bd99-98e4b4c3c773","_postman_id":"f219e186-8861-48ce-bd99-98e4b4c3c773","description":""}],"variable":[{"key":"baseUrl","value":"https://api.vidalytics.com/public/v1"}]}