{ "opencollection": "1.0.0", "info": { "name": "Mux Animated Images Video Views API", "version": "v1" }, "items": [ { "info": { "name": "Video Views", "type": "folder" }, "items": [ { "info": { "name": "List Video Views", "type": "http" }, "http": { "method": "GET", "url": "https://api.mux.com/data/v1/video-views", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of items to include in the response" }, { "name": "page", "value": "", "type": "query", "description": "Offset by this many pages, of the size of `limit`" }, { "name": "viewer_id", "value": "", "type": "query", "description": "Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux." }, { "name": "error_id", "value": "", "type": "query", "description": "Filter video views by the provided error ID (as returned in the error_type_id field in the list video views endpoint). If you provide any as the error ID, this will filter the results to those with any error." }, { "name": "order_direction", "value": "", "type": "query", "description": "Sort order." }, { "name": "filters[]", "value": "", "type": "query", "description": "Filter results using key:value pairs. Must be provided as an array query string parameter.\n\n**Basic filtering:**\n* `filters[]=dimension:value` - Include rows where dimension equals value\n* `filters[]=!dimension:value` - Exclude rows where dimension equals value\n\n**For trace dimensions (like video_cdn_trace):**\n* `filters[]=+dimension:value` - Include rows where trace contains value\n* `filters[]=-dimension:value` - Exclude rows where trace contains value\n* `filters[]=dimension:[value1,value2]` - Exact trace match\n\n**Examples:**\n* `filters[]=country:US` - US views only\n* `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN\n" }, { "name": "metric_filters[]", "value": "", "type": "query", "description": "Limit the results to rows that match inequality conditions from provided metric comparison clauses. Must be provided as an array query string parameter.\n\nPossible filterable metrics are the same as the set of metric ids, with the exceptions of `exits_before_video_start`, `unique_viewers`, `video_startup_failure_percentage`, `view_dropped_percentage`, and `views`.\n\nExample:\n\n * `metric_filters[]=aggregate_startup_time>=1000`\n" }, { "name": "timeframe[]", "value": "", "type": "query", "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of video views which match the filters and have a `view_end` within the specified timeframe." }, { "info": { "name": "Get a Video View", "type": "http" }, "http": { "method": "GET", "url": "https://api.mux.com/data/v1/video-views/:VIDEO_VIEW_ID", "params": [ { "name": "VIDEO_VIEW_ID", "value": "abcd1234", "type": "path", "description": "ID of the Video View" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of a video view." } ] } ], "bundled": true }