{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"335b05fc-6329-49fe-9b83-4fa57f02e491","name":"Visaic Data IQ","description":"# Visaic Data IQ\n\nThe **Visaic Data IQ** collection provides access to Visaic's video analytics API for collecting, tracking, and retrieving real-time and historical metrics for video playback, campaigns, dashboards, games, and real-time viewers.\n\n---\n\n## Collection overview\n\n**Collection name**: Visaic Data IQ  \n**Purpose**: Query video analytics data for dashboards, campaigns, users, games, and real-time views.\n\nTop-level folders:\n\n- **Real Time** – Real-time viewers and playback metrics.\n    \n- **Games** – Game-related analytics and metrics.\n    \n- **Users** – User lookup and analytics.\n    \n- **Platform** – Platform-level configuration or status endpoints.\n    \n- **Highlights** – Highlight-specific analytics.\n    \n- **Campaigns** – Campaign stats and reporting.\n    \n- **Dashboard** – Core dashboard and base analytics reports.\n    \n\nTop-level requests:\n\n- `GET {{url}}/` – Status of the service (healthcheck / basic availability)\n    \n\n---\n\n## Key folders and example requests\n\nBelow is a non-exhaustive overview of key folders and representative requests. All URLs are relative to `{{url}}`.\n\n### Real Time\n\n- `GET {{url}}/report/realtime/dynamodb/viewers/` – Real-time viewers by stream or channel.\n    \n\n### Dashboard\n\n- `GET {{url}}/report/dashboard/?start_date=YYYY-MM-DD&end_date=YYYY-MM-DD` – Main dashboard summary for a date range.\n    \n- `GET {{url}}/report/base/stream/` – Base stream analytics.\n    \n- `GET {{url}}/report/base/events/` – Base event analytics.\n    \n- `GET {{url}}/report/base/revenues/` – Base revenue analytics.\n    \n- `GET {{url}}/report/base/ga/` – Google Analytics-based dashboard metrics.\n    \n- `GET {{url}}/report/highlights/` – Highlights performance and engagement metrics.\n    \n\n### Campaigns\n\n- `GET {{url}}/campaign/stats/{campaign_id}` – Campaign stats for a specific campaign.\n    \n\n### Users\n\n- `POST {{url}}/campaign/search_users` – Search for users associated with campaigns.\n    \n\n### Games\n\n- Game analytics endpoints for events, games, and related engagement metrics.\n    \n\n---\n\n## Environments and variables\n\nThis collection expects an environment with the following variables. The following are defined:\n\n**Environment variables (Black Bear):**\n\n- `url` – Base URL for the Visaic Data IQ API (e.g., `{{url}}` ).\n    \n- `api_key` – API key or token used for Authorization.\n    \n- `profile` – Optional profile/tenant identifier used by the backend (if required by your setup).\n    \n\n---\n\n## Authentication\n\nThe collection does not currently define an explicit collection-level auth configuration. Typical deployments use one of the following patterns:\n\n1. **API key in header**\n    \n    - Header: `Authorization: {{api_key}}`\n        \n\nCheck individual requests in the collection for the exact header names if they have been configured. If not, add the appropriate auth header at either:\n\n- The **collection level** (applies to all requests), or\n    \n- Individual requests that need specific credentials.\n    \n\n# Visaic Data IQ — Metric Glossary\n\n---\n\n## Audience\n\n**Category:** Reach\n\nThe total count of unique viewer sessions that accessed content during a given period. Each active session — whether initiated by an authenticated user or an anonymous viewer — is recorded as one audience unit. A viewer accessing content simultaneously from two devices, regardless of login status, is counted as two separate audience sessions, as the system tracks presence at the session level rather than at the account level.\n\n---\n\n## View\n\n**Category:** Engagement\n\nA single playback event, counted when a viewer initiates playback and the video player successfully renders the first frame. Each deliberate play action — including page refreshes followed by re-initiating playback — is recorded as an independent view. This metric reflects intent-driven engagement rather than passive exposure.\n\n---\n\n## Viewing Time\n\n**Category:** Consumption\n\nThe cumulative duration, measured in seconds, that a viewer spent actively watching a video. Viewing Time reflects actual consumption and is used to assess content depth, audience retention, and overall engagement quality beyond simple view counts.\n\n## Real Views\n\n**Category:** Engagement — (On development)\n\nA subset of total Views that excludes any playback session where the viewer watched less than 5 seconds of content. While a standard View is recorded the moment the first frame renders, a Real View requires a minimum sustained watch duration, filtering out accidental plays, page-load autoplays, or viewers who immediately abandoned the content. This metric provides a more accurate representation of intentional engagement.\n\n---\n\n## Real Viewing Time\n\n**Category:** Consumption — (On development)\n\nThe cumulative watch duration, measured in seconds, attributed exclusively to sessions that qualify as Real Views (i.e. sessions where the viewer watched 5 seconds or more). Viewing time from sessions below the 5-second threshold is excluded entirely. This metric is used alongside Real Views to assess true content consumption depth, free from noise generated by incidental or abandoned playback events.\n\n---","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14276323","team":1006397,"collectionId":"335b05fc-6329-49fe-9b83-4fa57f02e491","publishedId":"2sBXVkCV9B","public":true,"publicUrl":"https://doc.analytics.visaic.com.ua","privateUrl":"https://go.postman.co/documentation/14276323-335b05fc-6329-49fe-9b83-4fa57f02e491","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-01-23T20:39:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/4f69640a82b024ad66e8a6cdbf89ac8c08e7a4f1d765c262846e5ff4a220c007","favicon":"https://visaic.com.ua/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://doc.analytics.visaic.com.ua/view/metadata/2sBXVkCV9B"}