This is the OpenAPI specification for the Mux Data API. ```json { "openapi": "3.1.0", "x-group-parameters": true, "info": { "title": "Mux API", "description": "Mux is how developers build online video. This API encompasses Mux Data functionality to help you build your data-related projects better and faster than ever before.", "version": "v1", "contact": { "name": "Mux DevEx", "url": "https://docs.mux.com", "email": "devex@mux.com" } }, "servers": [ { "url": "https://api.mux.com", "description": "Mux Production API" } ], "security": [ { "accessToken": [] }, { "authorizationToken": [] } ], "tags": [ { "name": "Video Views", "description": "An individual video view tracked by Mux Data. For the full list of properties for each view please refer to the table of data fields in the [Export raw video view data guide](https://docs.mux.com/guides/export-raw-video-view-data)." }, { "name": "Errors", "description": "Playback errors are tracked and aggregated by Mux Data. Errors can be listed by the API, which contains data about the error code, message, and how often the error occurred." }, { "name": "Filters", "description": "Deprecated, please refer to the Dimensions APIs." }, { "name": "Dimensions", "description": "Dimensions are the types of metadata that can be collected for a video view. Some dimensions are collected automatically based on the playback or device, such as the viewer's Country or the device information. Other dimensions are specified by the developer when configuring a Mux Data video view such as the video title. The Dimensions APIs allow you to get a list of the supported dimensions and their values." }, { "name": "Exports", "description": "Exports allow you to download the daily CSV files that are generated from the video views that occurred in the previous day. Please contact [support](mailto:support@mux.com) for information about enabling exports for your organization." }, { "name": "Metrics", "description": "Historical metrics are used for tracking KPIs, diagnosing issues, and\nmeasuring viewers' quality of experience. Metrics are calculated using the\nvideo views that have been completed and are bucketed on the view end time\nfor quality of experience metrics and view start time for engagement\nmetrics. Historical metrics provide a large collection of dimensions that\ncan be used to aggregate quality of experience based on view metadata. You\ncan also easily compare experiences across viewer populations to, for\nexample, find issues with specific devices or geographies.\n\nHistorical metrics are similar but not directly comparable to the real-time\nmetrics in the Real-time APIs. These metrics are aggregated for long-term\nstorage historical reporting and are generated using different viewer\npopulations.\n" }, { "name": "Monitoring", "description": "Monitoring metrics are used for operational monitoring of a video platform.\nThe metrics are aggregated in five second intervals, across the views that\nare currently being watched. The real-time metrics' timeline, breakdown,\nand histogram representations are available via the APIs.\n\nMonitoring metrics are similar but not directly comparable to the historical\nmetrics in the Metrics APIs. These metrics are aggregated to provide the most\noperational detail possible used for resolving operational issues.\nMux Data Monitoring metrics are available to Mux Data customers on a Media plan.\n" }, { "name": "Real-Time", "description": "The Mux Data Real-time API has been deprecated, please refer to the\nMux Data `Monitoring` APIs which provide the same functionality.\nMux Data Monitoring metrics are available to Mux Data customers on a Media plan.\n" }, { "name": "Incidents", "description": "Incidents occur when an anomaly alert is triggered in Mux Data. The Incidents API provides operations related to the raising and managing of alerting incidents." }, { "name": "Annotations", "description": "Annotations allow you to add notes at a specific datetime to view in the Mux Data dashboard." } ], "paths": { "/data/v1/video-views": { "get": { "tags": [ "Video Views" ], "summary": "List Video Views", "description": "Returns a list of video views which match the filters and have a `view_end` within the specified timeframe.", "operationId": "list-video-views", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/viewer_id" }, { "$ref": "#/components/parameters/error_id" }, { "$ref": "#/components/parameters/order_direction" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVideoViewsResponse" }, "example": { "total_row_count": 4, "timeframe": [ 1610025789, 1610112189 ], "data": [ { "viewer_os_family": "OS X", "viewer_application_name": "Chrome", "view_start": "2021-01-07T20:34:06Z", "view_end": "2021-01-07T20:46:04Z", "video_title": "my-title", "total_row_count": 4, "player_error_message": null, "player_error_code": null, "id": "JpA81zBfGaGZ85C6aGF3bptyD4CKwpdNgamr", "error_type_id": 1, "country_code": "US", "viewer_experience_score": 0.8, "watch_time": 1000, "playback_failure": false }, { "viewer_os_family": "OS X", "viewer_application_name": "Chrome", "view_start": "2021-01-07T20:21:53Z", "view_end": "2021-01-07T20:34:03Z", "video_title": "", "total_row_count": 4, "player_error_message": null, "player_error_code": null, "id": "jPVLR5giYMrLYbHM88Tkn3cM3qCRDk0jL114", "error_type_id": 1, "country_code": "US", "viewer_experience_score": 0.8, "watch_time": 1000, "playback_failure": false }, { "viewer_os_family": "OS X", "viewer_application_name": "Chrome", "view_start": "2021-01-07T15:16:06Z", "view_end": "2021-01-07T15:17:06Z", "video_title": "Video Test Title 12.14.20", "total_row_count": 4, "player_error_message": "this is an error message from the player", "player_error_code": "1001", "id": "pdLDVKBuPZJJ9YsPVmtmB9FG9gsWBWMmYar4", "error_type_id": 1, "country_code": "US", "viewer_experience_score": 0.8, "watch_time": 1000, "playback_failure": true }, { "viewer_os_family": "OS X", "viewer_application_name": "Chrome", "view_start": "2021-01-07T15:15:09Z", "view_end": "2021-01-07T15:15:17Z", "video_title": "Video Test Title 12.14.20", "total_row_count": 4, "player_error_message": null, "player_error_code": null, "id": "zbZPowWtD3z54jcGMLCJJpF79zCjB03bV7o8", "error_type_id": 1, "country_code": "US", "viewer_experience_score": 0.8, "watch_time": 1000, "playback_failure": false } ] } } } } } } }, "/data/v1/video-views/{VIDEO_VIEW_ID}": { "get": { "tags": [ "Video Views" ], "summary": "Get a Video View", "description": "Returns the details of a video view.", "operationId": "get-video-view", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/video_view_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoViewResponse" }, "example": { "total_row_count": null, "timeframe": [ 1643133378, 1643219778 ], "data": { "id": "LOpk9M00bMWgOJ3hcTcCHmz1JjxMFRRI", "ad_attempt_count": null, "ad_break_count": null, "ad_break_error_count": null, "ad_break_error_percentage": null, "ad_error_count": null, "ad_error_percentage": null, "ad_exit_before_start_count": null, "ad_exit_before_start_percentage": null, "ad_impression_count": null, "ad_playback_failure_error_type_id": null, "ad_preroll_startup_time": null, "ad_startup_error_count": null, "ad_startup_error_percentage": null, "asn": 11427, "asn_name": null, "asset_id": "rmp7fvw5lPD01l8PZ2aN74js84XrTWxHy", "audio_codec": null, "audio_codec_initial": null, "buffering_count": null, "buffering_duration": null, "buffering_rate": null, "cdn": null, "city": "Austin", "client_application_name": null, "client_application_version": null, "continent_code": null, "country_code": "US", "country_name": "United States", "custom_1": null, "custom_2": null, "custom_3": null, "custom_4": null, "custom_5": null, "custom_6": null, "custom_7": null, "custom_8": null, "custom_9": null, "custom_10": null, "environment_id": "envid123", "error_type_id": null, "events": [ { "viewer_time": 1643216891851, "playback_time": 0, "name": "playerready", "event_time": 1643216898061, "details": {} }, { "viewer_time": 1643216891853, "playback_time": 0, "name": "viewstart", "event_time": 1643216898101, "details": {} } ], "exit_before_video_start": false, "experiment_name": null, "inserted_at": "2022-01-26T17:08:18Z", "isp": null, "latitude": null, "live_stream_id": null, "live_stream_latency": null, "long_rebuffering": false, "long_resume": false, "longitude": null, "metro": null, "mux_api_version": "v1", "mux_embed": null, "mux_embed_version": null, "mux_viewer_id": "abc123viewerid", "page_load_time": null, "page_type": null, "page_url": null, "platform_description": null, "platform_summary": null, "playback_business_exception_error_type_id": null, "playback_failure": false, "playback_failure_error_type_id": null, "playback_id": null, "playback_score": null, "player_autoplay": false, "player_error_code": "1001", "player_error_context": "error context", "player_error_message": "error from player", "player_height": null, "player_instance_id": null, "player_language": null, "player_load_time": null, "player_mux_plugin_name": "apple-mux", "player_mux_plugin_version": null, "player_name": null, "player_poster": null, "player_preload": false, "player_remote_played": null, "player_software": null, "player_software_version": null, "player_source_domain": null, "player_source_duration": null, "player_source_height": null, "player_source_host_name": "stream.mux.com", "player_source_stream_type": null, "player_source_type": null, "player_source_url": "https://stream.mux.com/ax9qwyTIaUDLdmhesYDKir5kfE4Ve215.m3u8", "player_source_width": null, "player_startup_time": null, "player_version": null, "player_view_count": null, "player_width": null, "preroll_ad_asset_hostname": null, "preroll_ad_tag_hostname": null, "preroll_played": null, "preroll_requested": null, "property_id": 1234, "quality_score": null, "rebuffer_percentage": null, "rebuffering_score": null, "region": null, "rendition_change_count": null, "rendition_downshift_count": null, "rendition_upshift_count": null, "requests_for_first_preroll": null, "session_id": "b97d7b4a-8de7-4b18-8984-1f9ec3d3b5bc", "short_time": "2022-01-26T17:08:18Z", "startup_score": null, "sub_property_id": null, "time_shift_enabled": false, "time_to_first_frame": null, "updated_at": "2022-01-26T17:56:12Z", "used_captions": false, "used_fullscreen": false, "used_pip": false, "video_affiliate": null, "video_brand": null, "video_cdn_trace": [], "video_codec": null, "video_codec_initial": null, "video_content_type": null, "video_creator_id": null, "video_duration": null, "video_dynamic_range_type": null, "video_dynamic_range_type_initial": null, "video_encoding_variant": null, "video_id": "rmp7fvw5lPD01l8PZ2aN74js84XrTWxHy", "video_language": null, "video_producer": null, "video_series": null, "video_source_bitrate": null, "video_source_bitrate_initial": null, "video_source_fps": null, "video_source_fps_initial": null, "video_source_height": null, "video_source_height_initial": null, "video_source_width": null, "video_source_width_initial": null, "video_startup_business_exception_error_type_id": null, "video_startup_failure": false, "video_startup_preroll_load_time": null, "video_startup_preroll_request_time": null, "video_stream_type": null, "video_title": null, "video_variant_id": null, "video_variant_name": null, "view_average_request_latency": null, "view_average_request_throughput": null, "view_cdn_edge_pop": null, "view_cdn_origin": null, "view_content_startup_time": null, "view_drm_level": null, "view_drm_type": null, "view_dropped": false, "view_dropped_frame_count": null, "view_end": "2022-01-26T17:56:12Z", "view_error_id": null, "view_has_ad": false, "view_id": "8d00a0ca-8456-4e55-9ff8-dc501814a6b1", "view_max_downscale_percentage": "0.32222223", "view_max_playhead_position": "41126", "view_max_request_latency": null, "view_max_upscale_percentage": "0", "view_playing_time": "58134", "view_seek_count": null, "view_seek_duration": null, "view_session_id": null, "view_start": "2022-01-26T17:08:18Z", "view_total_content_playback_time": 37521, "view_total_downscaling": null, "view_total_upscaling": null, "viewer_application_engine": null, "viewer_application_name": null, "viewer_application_version": null, "viewer_connection_type": null, "viewer_device_category": null, "viewer_device_manufacturer": null, "viewer_device_model": "iPhone10,4", "viewer_device_name": null, "viewer_experience_score": null, "viewer_os_architecture": null, "viewer_os_family": null, "viewer_os_version": "15.1", "viewer_plan": null, "viewer_plan_category": null, "viewer_plan_status": null, "viewer_user_agent": null, "viewer_user_id": null, "watch_time": null, "watched": true, "weighted_average_bitrate": 697078 } } } } } } } }, "/data/v1/errors": { "get": { "tags": [ "Errors" ], "summary": "List Errors", "description": "Returns a list of errors.", "operationId": "list-errors", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListErrorsResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610027061, 1610113461 ], "data": [ { "percentage": 30, "notes": "a helpful note", "message": "an error message", "last_seen": "2021-01-08T13:42:39Z", "id": 1, "description": "a description for this error", "count": 1, "code": 100, "player_error_code": "100" } ] } } } } } } }, "/data/v1/filters": { "get": { "deprecated": true, "tags": [ "Filters" ], "summary": "List Filters", "description": "The API has been replaced by the list-dimensions API call.\n\nLists all the filters broken out into basic and advanced.\n", "operationId": "list-filters", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFiltersResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610027251, 1610113651 ], "data": { "basic": [ "browser", "operating_system", "player_remote_played", "player_software", "player_software_version", "player_mux_plugin_name", "player_mux_plugin_version", "player_autoplay", "player_preload", "video_title", "video_id", "stream_type", "source_type", "source_hostname", "continent_code", "country", "player_error_code", "asset_id", "live_stream_id", "playback_id", "video_content_type", "page_type", "view_drm_type", "view_has_ad", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "view_dropped" ], "advanced": [ "browser_version", "operating_system_version", "viewer_device_name", "viewer_device_model", "viewer_device_category", "viewer_device_manufacturer", "player_name", "player_version", "video_series", "video_encoding_variant", "experiment_name", "sub_property_id", "asn", "cdn", "viewer_connection_type", "view_session_id", "region", "viewer_user_id", "exit_before_video_start", "video_startup_failure", "playback_failure", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "playback_business_exception", "video_startup_business_exception", "ad_playback_failure", "content_playback_failure" ] } } } } } } } }, "/data/v1/filters/{FILTER_ID}": { "get": { "deprecated": true, "tags": [ "Filters" ], "summary": "Lists values for a specific filter", "description": "The API has been replaced by the list-dimension-values API call.\n\nLists the values for a filter along with a total count of related views.\n", "operationId": "list-filter-values", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/filter_id" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListFilterValuesResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610028123, 1610114523 ], "data": [ { "value": "Chrome", "total_count": 5 } ] } } } } } } }, "/data/v1/dimensions": { "get": { "tags": [ "Dimensions" ], "summary": "List Dimensions", "description": "List all available dimensions.\n\nNote: This API replaces the list-filters API call.\n", "operationId": "list-dimensions", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDimensionsResponse" }, "example": { "data": { "advanced": [ "asn", "audio_codec", "audio_codec_initial", "browser_version", "client_application_name", "client_application_version", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "custom_11", "custom_12", "custom_13", "custom_14", "custom_15", "custom_16", "custom_17", "custom_18", "custom_19", "custom_20", "experiment_name", "environment_id", "operating_system_version", "page_type", "page_url", "playback_failure", "playback_business_exception", "player_autoplay", "player_error_code", "player_language", "player_mux_plugin_name", "player_mux_plugin_version", "player_poster", "player_preload", "player_remote_played", "player_software_version", "player_version", "region", "source_hostname", "time_shift_enabled", "used_captions", "used_pip", "video_affiliate", "video_brand", "video_cdn_trace", "video_codec", "video_codec_initial", "video_creator_id", "video_dynamic_range_type", "video_dynamic_range_type_initial", "video_encoding_variant", "video_language", "video_producer", "video_source_bitrate", "video_source_bitrate_initial", "video_source_fps", "video_source_fps_initial", "video_source_height", "video_source_height_initial", "video_source_width", "video_source_width_initial", "video_startup_business_exception", "video_variant_id", "video_variant_name", "view_cdn_edge_pop", "view_cdn_origin", "view_drm_type", "view_dropped", "view_dropped_frame_count", "view_session_id", "viewer_connection_type", "viewer_device_model", "viewer_user_id", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level" ], "basic": [ "asset_id", "browser", "cdn", "continent_code", "exit_before_video_start", "live_stream_id", "operating_system", "playback_id", "player_name", "player_software", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_id", "video_series", "video_startup_failure", "video_title", "view_has_ad", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_name" ] }, "timeframe": [ 1610033879, 1610120279 ], "total_row_count": 1 } } } } } } }, "/data/v1/dimensions/{DIMENSION_ID}": { "get": { "tags": [ "Dimensions" ], "summary": "Lists the values for a specific dimension", "description": "Lists the values for a dimension along with a total count of related views.\n\nNote: This API replaces the list-filter-values API call.\n", "operationId": "list-dimension-values", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/dimension_id" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDimensionValuesResponse" }, "example": { "data": [ { "total_count": 10000, "value": "FR" }, { "total_count": 5000, "value": "ES" }, { "total_count": 2000, "value": "PT" }, { "total_count": 100, "value": "DE" }, { "total_count": 1, "value": "BE" } ], "timeframe": [ 1610033976, 1610120376 ], "total_row_count": 5 } } } } } } }, "/data/v1/dimensions/{DIMENSION_ID}/elements": { "get": { "tags": [ "Dimensions" ], "summary": "Lists elements for a trace dimension", "description": "Lists the elements (values) for a trace dimension along with their total counts.\nThis endpoint is specifically designed for trace dimensions like video_cdn_trace\nthat contain arrays of values.\n", "operationId": "list-dimension-elements", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/dimension_id" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/timeframe" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDimensionValuesResponse" }, "example": { "total_row_count": 25, "timeframe": [ 1755069000, 1755155999 ], "data": [ { "value": "cdn_a", "total_count": 2640882 }, { "value": "cdn_b", "total_count": 1368812 }, { "value": "cdn_c", "total_count": 154541 } ] } } } } } } }, "/data/v1/exports": { "get": { "deprecated": true, "tags": [ "Exports" ], "summary": "List property video view export links", "description": "The API has been replaced by the list-exports-views API call.\n\nLists the available video view exports along with URLs to retrieve them.\n", "operationId": "list-exports", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListExportsResponse" }, "example": { "total_row_count": 10, "timeframe": [ 1610024528, 1610110928 ], "data": [ "https://s3.amazonaws.com/mux-data-exports/1/2021_01_01.csv.gz?...signature...", "https://s3.amazonaws.com/mux-data-exports/1/2021_01_02.csv.gz?...signature...", "https://s3.amazonaws.com/mux-data-exports/1/2021_01_03.csv.gz?...signature..." ] } } } } } } }, "/data/v1/exports/views": { "get": { "tags": [ "Exports" ], "summary": "List available property view exports", "description": "Lists the available video view exports along with URLs to retrieve them.", "operationId": "list-exports-views", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListVideoViewExportsResponse" }, "example": { "total_row_count": 7, "timeframe": [ 1626296941, 1626383341 ], "data": [ { "files": [ { "version": 2, "type": "csv", "path": "https://s3.amazonaws.com/mux-data-exports/1/2021_01_03.csv.gz?...signature..." } ], "export_date": "2021-01-03" }, { "files": [ { "version": 2, "type": "csv", "path": "https://s3.amazonaws.com/mux-data-exports/1/2021_01_02.csv.gz?...signature..." } ], "export_date": "2021-01-02" }, { "files": [ { "version": 2, "type": "csv", "path": "https://s3.amazonaws.com/mux-data-exports/1/2021_01_01.csv.gz?...signature..." } ], "export_date": "2021-01-01" } ] } } } } } } }, "/data/v1/metrics/{METRIC_ID}/breakdown": { "get": { "tags": [ "Metrics" ], "summary": "List breakdown values", "description": "List the breakdown values for a specific metric.", "operationId": "list-breakdown-values", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/metric_id" }, { "$ref": "#/components/parameters/group_by" }, { "$ref": "#/components/parameters/measurement" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBreakdownValuesResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610028298, 1610114698 ], "meta": { "aggregation": "view_end" }, "data": [ { "views": 5, "value": 4, "total_watch_time": 513934, "total_playing_time": 413934, "negative_impact": 1, "field": "US" } ] } } } } } } }, "/data/v1/metrics/{METRIC_ID}/overall": { "get": { "tags": [ "Metrics" ], "summary": "Get Overall values", "description": "Returns the overall value for a specific metric, as well as the total view count, watch time, and the Mux Global metric value for the metric.", "operationId": "get-overall-values", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/metric_id" }, { "$ref": "#/components/parameters/timeframe" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/measurement" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOverallValuesResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610029525, 1610115925 ], "meta": { "aggregation": "view_end" }, "data": { "value": 4, "total_watch_time": 513934, "total_playing_time": 413934, "total_views": 5, "global_value": 1169.1832095168065 } } } } } } } }, "/data/v1/metrics/{METRIC_ID}/insights": { "get": { "tags": [ "Metrics" ], "summary": "List Insights", "description": "Returns a list of insights for a metric. These are the worst performing values across all breakdowns sorted by how much they negatively impact a specific metric.", "operationId": "list-insights", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/metric_id" }, { "$ref": "#/components/parameters/measurement" }, { "$ref": "#/components/parameters/order_direction_deprecated" }, { "$ref": "#/components/parameters/timeframe" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInsightsResponse" }, "example": { "total_row_count": 18, "timeframe": [ 1610029610, 1610116010 ], "meta": { "aggregation": "view_end" }, "data": [ { "total_watch_time": 351144, "total_playing_time": 341144, "total_views": 1, "negative_impact_score": -5, "metric": 9, "filter_value": "", "filter_column": "video_title" }, { "total_watch_time": 513934, "total_playing_time": 413934, "total_views": 5, "negative_impact_score": 0, "metric": 4, "filter_value": "US", "filter_column": "country" } ] } } } } } } }, "/data/v1/metrics/{METRIC_ID}/timeseries": { "get": { "tags": [ "Metrics" ], "summary": "Get metric timeseries data", "description": "Returns timeseries data for a specific metric.\n\nEach interval represented in the data array contains an array with the following values:\n * the first element is the interval time\n * the second element is the calculated metric value\n * the third element is the number of views in the interval that have a valid metric value\n", "operationId": "get-metric-timeseries-data", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/metric_id" }, { "$ref": "#/components/parameters/timeframe" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/measurement" }, { "$ref": "#/components/parameters/order_direction" }, { "$ref": "#/components/parameters/timeseries_group_by" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMetricTimeseriesDataResponse" }, "example": { "total_row_count": 2, "timeframe": [ 1610029711, 1610116111 ], "meta": { "aggregation": "view_end" }, "data": [ [ "2021-01-07T14:00:00Z", "0.8743536882994202", "154240" ], [ "2021-01-07T15:00:00Z", "0.8929105055911401", "156056" ] ] } } } } } } }, "/data/v1/metrics/comparison": { "get": { "tags": [ "Metrics" ], "summary": "List all metric values", "description": "List all of the values across every breakdown for a specific metric.", "operationId": "list-all-metric-values", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/timeframe" }, { "$ref": "#/components/parameters/filters" }, { "$ref": "#/components/parameters/metric_filters" }, { "$ref": "#/components/parameters/dimension" }, { "$ref": "#/components/parameters/value" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllMetricValuesResponse" }, "example": { "total_row_count": 1, "timeframe": [ 1610029906, 1610116306 ], "data": [ { "watch_time": 513934, "view_count": 5, "started_views": 6, "ended_views": 5, "unique_viewers": 6, "total_playing_time": 503934, "name": "totals" }, { "value": 6, "type": "number", "name": "Views", "metric": "views", "items": [ { "value": 6, "type": "number", "name": "Unique Viewers", "metric": "unique_viewers" }, { "value": 503934, "type": "milliseconds", "name": "Playing Time", "metric": "playing_time" }, { "value": 0, "type": "number", "name": "Ad Attempts (total)", "metric": "ad_attempt_count", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Attempts (average)", "metric": "ad_attempt_count", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Breaks (total)", "metric": "ad_break_count", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Breaks (average)", "metric": "ad_break_count", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Impressions (total)", "metric": "ad_impression_count", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Impressions (average)", "metric": "ad_impression_count", "measurement": "avg" } ] }, { "value": 0.7803472280502319, "type": "score", "name": "Overall Score", "metric": "viewer_experience_score" }, { "value": 0.8, "type": "score", "name": "Playback Failure Score", "metric": "playback_failure_score", "items": [ { "value": 0.2, "type": "percentage", "name": "Playback Failure Percentage", "metric": "playback_failure_percentage" }, { "value": 0, "type": "percentage", "name": "Video Startup Failure Percentage", "metric": "video_startup_failure_percentage" }, { "value": 0, "type": "percentage", "name": "Exits Before Video Start", "metric": "exits_before_video_start" }, { "value": 0, "type": "percentage", "name": "View Dropped Percentage", "metric": "view_dropped_percentage" }, { "value": 0, "type": "number", "name": "Ad Errors (total)", "metric": "ad_error_count", "measurement": "sum" }, { "value": 0, "type": "number", "name": "Ad Errors (average)", "metric": "ad_error_count", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Ad Error Percentage (average)", "metric": "ad_error_percentage", "measurement": "avg" }, { "value": 0, "type": "number", "name": "Ad Break Errors (total)", "metric": "ad_break_error_count", "measurement": "sum" }, { "value": 0, "type": "number", "name": "Ad Break Errors (average)", "metric": "ad_break_error_count", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Ad Break Error Percentage (average)", "metric": "ad_break_error_percentage", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Ad Startup Error Percentage (average)", "metric": "ad_startup_error_percentage", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Ad Exit Before Start Percentage (average)", "metric": "ad_exit_before_start_percentage", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Playback Business Exception Percentage (average)", "metric": "playback_business_exception_percentage", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Video Startup Business Exception Percentage (average)", "metric": "video_startup_business_exception_percentage", "measurement": "avg" } ] }, { "value": 0.9991008877754212, "type": "score", "name": "Startup Time Score", "metric": "startup_time_score", "items": [ { "value": 4, "type": "milliseconds", "name": "Video Startup Time (median)", "metric": "video_startup_time", "measurement": "median" }, { "value": 9, "type": "milliseconds", "name": "Video Startup Time (95th %)", "metric": "video_startup_time", "measurement": "95th" }, { "value": 52.5625, "type": "milliseconds", "name": "Player Startup Time (median)", "metric": "player_startup_time", "measurement": "median" }, { "value": 60.0625, "type": "milliseconds", "name": "Player Startup Time (95th %)", "metric": "player_startup_time", "measurement": "95th" }, { "value": 122.37890625, "type": "milliseconds", "name": "Page Load Time (median)", "metric": "page_load_time", "measurement": "median" }, { "value": 264.0625, "type": "milliseconds", "name": "Page Load Time (95th %)", "metric": "page_load_time", "measurement": "95th" }, { "value": 182.25, "type": "milliseconds", "name": "Aggregate Startup Time (median)", "metric": "aggregate_startup_time", "measurement": "median" }, { "value": 319.515625, "type": "milliseconds", "name": "Aggregate Startup Time (95th %)", "metric": "aggregate_startup_time", "measurement": "95th" }, { "value": 3042, "type": "milliseconds", "name": "Seek Latency", "metric": "seek_latency" }, { "value": 1000, "type": "milliseconds", "name": "Content Startup Time (median)", "metric": "view_content_startup_time", "measurement": "median" }, { "value": 1403, "type": "milliseconds", "name": "Content Startup Time (95th %)", "metric": "view_content_startup_time", "measurement": "95th" }, { "value": 800, "type": "milliseconds", "name": "Ad Preroll Startup Time (median)", "metric": "ad_preroll_startup_time", "measurement": "median" }, { "value": 1243, "type": "milliseconds", "name": "Ad Preroll Startup Time (95th %)", "metric": "ad_preroll_startup_time", "measurement": "95th" } ] }, { "value": 0.9523247838020324, "type": "score", "name": "Rebuffer Score", "metric": "rebuffer_score", "items": [ { "value": 0.0005564916895943838, "type": "percentage", "name": "Rebuffer Percentage", "metric": "rebuffer_percentage" }, { "value": 0.11674650830651406, "type": "per_minute", "name": "Rebuffer Frequency", "metric": "rebuffer_frequency" }, { "value": 0, "type": "milliseconds", "name": "Rebuffer Duration (median)", "metric": "rebuffer_duration", "measurement": "median" }, { "value": 256, "type": "milliseconds", "name": "Rebuffer Duration (95th %)", "metric": "rebuffer_duration", "measurement": "95th" }, { "value": 0, "type": "number", "name": "Rebuffer Count (median)", "metric": "rebuffer_count", "measurement": "median" }, { "value": 1, "type": "number", "name": "Rebuffer Count (95th %)", "metric": "rebuffer_count", "measurement": "95th" } ] }, { "value": 1, "type": "score", "name": "Video Quality Score", "metric": "video_quality_score", "items": [ { "value": 0, "type": "percentage", "name": "Upscale Percentage (median)", "metric": "upscale_percentage", "measurement": "median" }, { "value": 0, "type": "percentage", "name": "Upscale Percentage (95th %)", "metric": "upscale_percentage", "measurement": "95th" }, { "value": 0, "type": "percentage", "name": "Upscale Percentage (average)", "metric": "upscale_percentage", "measurement": "avg" }, { "value": 0.007, "type": "percentage", "name": "Downscale Percentage (median)", "metric": "downscale_percentage", "measurement": "median" }, { "value": 0.449, "type": "percentage", "name": "Downscale Percentage (95th %)", "metric": "downscale_percentage", "measurement": "95th" }, { "value": 0.11813909473676262, "type": "percentage", "name": "Downscale Percentage (average)", "metric": "downscale_percentage", "measurement": "avg" }, { "value": 0, "type": "percentage", "name": "Max Upscale Percentage (median)", "metric": "max_upscale_percentage", "measurement": "median" }, { "value": 0, "type": "percentage", "name": "Max Upscale Percentage (95th %)", "metric": "max_upscale_percentage", "measurement": "95th" }, { "value": 0.007, "type": "percentage", "name": "Max Downscale Percentage (median)", "metric": "max_downscale_percentage", "measurement": "median" }, { "value": 0.449, "type": "percentage", "name": "Max Downscale Percentage (95th %)", "metric": "max_downscale_percentage", "measurement": "95th" }, { "value": 851582.91015625, "type": "mbps", "name": "Weighted Average Bitrate (median)", "metric": "weighted_average_bitrate", "measurement": "median" }, { "value": 697016.265625, "type": "mbps", "name": "Weighted Average Bitrate (95th %)", "metric": "weighted_average_bitrate", "measurement": "95th" }, { "value": 2195, "type": "milliseconds", "name": "Live Stream Latency (median)", "metric": "live_stream_latency", "measurement": "median" }, { "value": 3523, "type": "milliseconds", "name": "Live Stream Latency (95th %)", "metric": "live_stream_latency", "measurement": "95th" } ] } ] } } } } } } }, "/data/v1/monitoring/dimensions": { "get": { "tags": [ "Monitoring" ], "summary": "List Monitoring Dimensions", "description": "Lists available monitoring dimensions.", "operationId": "list-monitoring-dimensions", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMonitoringDimensionsResponse" }, "example": { "data": [ { "display_name": "ASN", "name": "asn" }, { "display_name": "CDN", "name": "cdn" }, { "display_name": "Country", "name": "country" }, { "display_name": "Operating system", "name": "operating_system" }, { "display_name": "Player name", "name": "player_name" }, { "display_name": "Region / State", "name": "region" }, { "display_name": "Stream type", "name": "stream_type" }, { "display_name": "Sub property ID", "name": "sub_property_id" }, { "display_name": "Video series", "name": "video_series" }, { "display_name": "Video title", "name": "video_title" }, { "display_name": "View has ad", "name": "view_has_ad" } ], "timeframe": [ 1610034823, 1610121223 ], "total_row_count": 1 } } } } } } }, "/data/v1/monitoring/metrics": { "get": { "tags": [ "Monitoring" ], "summary": "List Monitoring Metrics", "description": "Lists available monitoring metrics.", "operationId": "list-monitoring-metrics", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListMonitoringMetricsResponse" }, "example": { "data": [ { "display_name": "Current Average Bitrate", "name": "current-average-bitrate" }, { "display_name": "Current Concurrent Viewers (CCV)", "name": "current-concurrent-viewers" }, { "display_name": "Current Rebuffering Percentage", "name": "current-rebuffering-percentage" }, { "display_name": "Exits Before Video Start", "name": "exits-before-video-start" }, { "display_name": "Playback Failure Percentage", "name": "playback-failure-percentage" }, { "display_name": "Video Startup Failure Percentage", "name": "video-startup-failure-percentage" }, { "display_name": "Video Startup Time", "name": "video-startup-time" } ], "timeframe": [ 1610034858, 1610121258 ], "total_row_count": 1 } } } } } } }, "/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown": { "get": { "tags": [ "Monitoring" ], "summary": "Get Monitoring Breakdown", "description": "Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.", "operationId": "get-monitoring-breakdown", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/monitoring_metric_id" }, { "$ref": "#/components/parameters/monitoring_dimension" }, { "$ref": "#/components/parameters/timestamp" }, { "$ref": "#/components/parameters/monitoring_filters" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMonitoringBreakdownResponse" }, "example": { "data": [ { "concurrent_viewers": 2680, "metric_value": 0.008195679660675846, "negative_impact": 1, "starting_up_viewers": 10, "value": "FR" }, { "concurrent_viewers": 36, "metric_value": 0.010317417106767573, "negative_impact": 4, "starting_up_viewers": 1, "value": "ES" }, { "concurrent_viewers": 30, "metric_value": 0.06408818534303201, "negative_impact": 2, "starting_up_viewers": 1, "value": "RE" }, { "concurrent_viewers": 26, "metric_value": 0.008232510579858339, "negative_impact": 7, "starting_up_viewers": 1, "value": "GB" }, { "concurrent_viewers": 10, "metric_value": 0, "negative_impact": 26, "starting_up_viewers": 0, "value": "BE" } ], "timeframe": [ 1610121421, 1610121421 ], "total_row_count": 1 } } } } } } }, "/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries": { "get": { "tags": [ "Monitoring" ], "summary": "Get Monitoring Breakdown Timeseries", "description": "Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.", "operationId": "get-monitoring-breakdown-timeseries", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/monitoring_metric_id" }, { "$ref": "#/components/parameters/monitoring_dimension" }, { "$ref": "#/components/parameters/monitoring_timeseries_timeframe" }, { "$ref": "#/components/parameters/monitoring_filters" }, { "$ref": "#/components/parameters/monitoring_timeseries_limit" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMonitoringBreakdownTimeseriesResponse" }, "example": { "data": [ { "values": [ { "value": "FR", "metric_value": 0.008195679660675846, "concurrent_viewers": 2680, "starting_up_viewers": 10 }, { "value": "ES", "metric_value": 0.010317417106767573, "concurrent_viewers": 36, "starting_up_viewers": 1 }, { "value": "GB", "metric_value": 0.008232510579858339, "concurrent_viewers": 26, "starting_up_viewers": 1 } ], "date": "2023-05-18T19:36:30Z" }, { "values": [ { "value": "FR", "metric_value": 0.00724579660675846, "concurrent_viewers": 2690, "starting_up_viewers": 1 }, { "value": "ES", "metric_value": 0.014317417106767573, "concurrent_viewers": 35, "starting_up_viewers": 15 }, { "value": "GB", "metric_value": 0.007232510579851874, "concurrent_viewers": 24, "starting_up_viewers": 1 } ], "date": "2023-05-18T19:36:35Z" } ], "timeframe": [ 1684438590, 1684438600 ], "total_row_count": 2 } } } } } } }, "/data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries": { "get": { "tags": [ "Monitoring" ], "summary": "Get Monitoring Histogram Timeseries", "description": "Gets histogram timeseries information for a specific metric.", "operationId": "get-monitoring-histogram-timeseries", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/monitoring_histogram_metric_id" }, { "$ref": "#/components/parameters/monitoring_filters" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMonitoringHistogramTimeseriesResponse" }, "example": { "data": [ { "average": 5298.1612903225805, "bucket_values": [ { "count": 3, "percentage": 0.0967741935483871 }, { "count": 0, "percentage": 0 }, { "count": 0, "percentage": 0 }, { "count": 1, "percentage": 0.03225806451612903 }, { "count": 16, "percentage": 0.5161290322580645 }, { "count": 7, "percentage": 0.22580645161290322 }, { "count": 4, "percentage": 0.12903225806451613 } ], "max_percentage": 0.5161290322580645, "median": 4463, "p95": 14834, "sum": 31, "timestamp": "2021-01-08T15:30:00Z" }, { "average": 3828.4146341463415, "bucket_values": [ { "count": 5, "percentage": 0.12195121951219512 }, { "count": 0, "percentage": 0 }, { "count": 0, "percentage": 0 }, { "count": 4, "percentage": 0.0975609756097561 }, { "count": 18, "percentage": 0.43902439024390244 }, { "count": 12, "percentage": 0.2926829268292683 }, { "count": 2, "percentage": 0.04878048780487805 } ], "max_percentage": 0.43902439024390244, "median": 2625, "p95": 7378, "sum": 41, "timestamp": "2021-01-08T15:31:00Z" } ], "meta": { "bucket_unit": "milliseconds", "buckets": [ { "end": 100, "start": 0 }, { "end": 500, "start": 100 }, { "end": 1000, "start": 500 }, { "end": 2000, "start": 1000 }, { "end": 5000, "start": 2000 }, { "end": 10000, "start": 5000 }, { "end": 15000, "start": 10000 } ] }, "timeframe": [ 1610119800, 1610121540 ], "total_row_count": 1 } } } } } } }, "/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries": { "get": { "tags": [ "Monitoring" ], "summary": "Get Monitoring Timeseries", "description": "Gets Time series information for a specific metric along with the number of concurrent viewers.", "operationId": "get-monitoring-timeseries", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/monitoring_metric_id" }, { "$ref": "#/components/parameters/monitoring_filters" }, { "$ref": "#/components/parameters/monitoring_timeseries_timestamp" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMonitoringTimeseriesResponse" }, "example": { "data": [ { "concurrent_viewers": 2790, "date": "2021-01-08T15:31:20Z", "value": 2790 }, { "concurrent_viewers": 2788, "date": "2021-01-08T15:31:25Z", "value": 2788 }, { "concurrent_viewers": 2791, "date": "2021-01-08T15:31:30Z", "value": 2791 }, { "concurrent_viewers": 2791, "date": "2021-01-08T15:31:35Z", "value": 2791 }, { "concurrent_viewers": 2792, "date": "2021-01-08T15:31:40Z", "value": 2792 } ], "timeframe": [ 1610119880, 1610121675 ], "total_row_count": 1 } } } } } } }, "/data/v1/realtime/dimensions": { "get": { "deprecated": true, "tags": [ "Real-Time" ], "summary": "List Real-Time Dimensions", "description": "Lists available real-time dimensions. This API is now deprecated, please use the `List Monitoring Dimensions` API.", "operationId": "list-realtime-dimensions", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRealTimeDimensionsResponse" }, "example": { "data": [ { "display_name": "ASN", "name": "asn" }, { "display_name": "CDN", "name": "cdn" }, { "display_name": "Country", "name": "country" }, { "display_name": "Operating system", "name": "operating_system" }, { "display_name": "Player name", "name": "player_name" }, { "display_name": "Region / State", "name": "region" }, { "display_name": "Stream type", "name": "stream_type" }, { "display_name": "Sub property ID", "name": "sub_property_id" }, { "display_name": "Video series", "name": "video_series" }, { "display_name": "Video title", "name": "video_title" } ], "timeframe": [ 1610034823, 1610121223 ], "total_row_count": 1 } } } } } } }, "/data/v1/realtime/metrics": { "get": { "deprecated": true, "tags": [ "Real-Time" ], "summary": "List Real-Time Metrics", "description": "Lists available real-time metrics. This API is now deprecated, please use the `List Monitoring Metrics` API.", "operationId": "list-realtime-metrics", "servers": [ { "url": "https://api.mux.com" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRealTimeMetricsResponse" }, "example": { "data": [ { "display_name": "Current Average Bitrate", "name": "current-average-bitrate" }, { "display_name": "Current Concurrent Viewers (CCV)", "name": "current-concurrent-viewers" }, { "display_name": "Current Rebuffering Percentage", "name": "current-rebuffering-percentage" }, { "display_name": "Exits Before Video Start", "name": "exits-before-video-start" }, { "display_name": "Playback Failure Percentage", "name": "playback-failure-percentage" }, { "display_name": "Video Startup Time", "name": "video-startup-time" } ], "timeframe": [ 1610034858, 1610121258 ], "total_row_count": 1 } } } } } } }, "/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown": { "get": { "deprecated": true, "tags": [ "Real-Time" ], "summary": "Get Real-Time Breakdown", "description": "Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. This API is now deprecated, please use the `Get Monitoring Breakdown` API.", "operationId": "get-realtime-breakdown", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/realtime_metric_id" }, { "$ref": "#/components/parameters/realtime_dimension" }, { "$ref": "#/components/parameters/timestamp" }, { "$ref": "#/components/parameters/monitoring_filters" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRealTimeBreakdownResponse" }, "example": { "data": [ { "concurrent_viewers": 2680, "metric_value": 0.008195679660675846, "negative_impact": 1, "starting_up_viewers": 10, "value": "FR" }, { "concurrent_viewers": 36, "metric_value": 0.010317417106767573, "negative_impact": 4, "starting_up_viewers": 1, "value": "ES" }, { "concurrent_viewers": 30, "metric_value": 0.06408818534303201, "negative_impact": 2, "starting_up_viewers": 1, "value": "RE" }, { "concurrent_viewers": 26, "metric_value": 0.008232510579858339, "negative_impact": 7, "starting_up_viewers": 1, "value": "GB" }, { "concurrent_viewers": 10, "metric_value": 0, "negative_impact": 26, "starting_up_viewers": 0, "value": "BE" } ], "timeframe": [ 1610121421, 1610121421 ], "total_row_count": 1 } } } } } } }, "/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries": { "get": { "deprecated": true, "tags": [ "Real-Time" ], "summary": "Get Real-Time Histogram Timeseries", "description": "Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the `Get Monitoring Histogram Timeseries` API.", "operationId": "get-realtime-histogram-timeseries", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/realtime_histogram_metric_id" }, { "$ref": "#/components/parameters/monitoring_filters" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRealTimeHistogramTimeseriesResponse" }, "example": { "data": [ { "average": 5298.1612903225805, "bucket_values": [ { "count": 3, "percentage": 0.0967741935483871 }, { "count": 0, "percentage": 0 }, { "count": 0, "percentage": 0 }, { "count": 1, "percentage": 0.03225806451612903 }, { "count": 16, "percentage": 0.5161290322580645 }, { "count": 7, "percentage": 0.22580645161290322 }, { "count": 4, "percentage": 0.12903225806451613 } ], "max_percentage": 0.5161290322580645, "median": 4463, "p95": 14834, "sum": 31, "timestamp": "2021-01-08T15:30:00Z" }, { "average": 3828.4146341463415, "bucket_values": [ { "count": 5, "percentage": 0.12195121951219512 }, { "count": 0, "percentage": 0 }, { "count": 0, "percentage": 0 }, { "count": 4, "percentage": 0.0975609756097561 }, { "count": 18, "percentage": 0.43902439024390244 }, { "count": 12, "percentage": 0.2926829268292683 }, { "count": 2, "percentage": 0.04878048780487805 } ], "max_percentage": 0.43902439024390244, "median": 2625, "p95": 7378, "sum": 41, "timestamp": "2021-01-08T15:31:00Z" } ], "meta": { "bucket_unit": "milliseconds", "buckets": [ { "end": 100, "start": 0 }, { "end": 500, "start": 100 }, { "end": 1000, "start": 500 }, { "end": 2000, "start": 1000 }, { "end": 5000, "start": 2000 }, { "end": 10000, "start": 5000 }, { "end": 15000, "start": 10000 } ] }, "timeframe": [ 1610119800, 1610121540 ], "total_row_count": 1 } } } } } } }, "/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries": { "get": { "deprecated": true, "tags": [ "Real-Time" ], "summary": "Get Real-Time Timeseries", "description": "Gets Time series information for a specific metric along with the number of concurrent viewers. This API is now deprecated, please use the `Get Monitoring Timeseries` API.", "operationId": "get-realtime-timeseries", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/realtime_metric_id" }, { "$ref": "#/components/parameters/monitoring_filters" }, { "$ref": "#/components/parameters/monitoring_timeseries_timestamp" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRealTimeTimeseriesResponse" }, "example": { "data": [ { "concurrent_viewers": 2790, "date": "2021-01-08T15:31:20Z", "value": 2790 }, { "concurrent_viewers": 2788, "date": "2021-01-08T15:31:25Z", "value": 2788 }, { "concurrent_viewers": 2791, "date": "2021-01-08T15:31:30Z", "value": 2791 }, { "concurrent_viewers": 2791, "date": "2021-01-08T15:31:35Z", "value": 2791 }, { "concurrent_viewers": 2792, "date": "2021-01-08T15:31:40Z", "value": 2792 } ], "timeframe": [ 1610119880, 1610121675 ], "total_row_count": 1 } } } } } } }, "/data/v1/incidents": { "get": { "tags": [ "Incidents" ], "summary": "List Incidents", "description": "Returns a list of incidents.", "operationId": "list-incidents", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" }, { "$ref": "#/components/parameters/incident_status" }, { "$ref": "#/components/parameters/severity" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIncidentsResponse" }, "example": { "data": [ { "affected_views": 71, "affected_views_per_hour": 29, "affected_views_per_hour_on_open": 75, "breakdowns": [ { "id": "abcdef", "name": "error_type_id", "value": "697070" } ], "description": "Something is broken", "error_description": "No seriously, something is really really broken :(", "id": "4u13td", "impact": "*71 views* were affected at a rate of *29 per hour*", "incident_key": "5312a7c0bbb5d8353bd88602f01fe58eb15e9febac8fd2f0d8ce8f1cb138145c", "measured_value": 5.9, "measured_value_on_close": 0.1, "measurement": "error_rate", "notification_rules": [], "notifications": [ { "attempted_at": "2021-01-05T09:52:15.119040Z", "id": 103014, "queued_at": "2021-01-05T09:52:14.945157Z" }, { "attempted_at": "2021-01-05T11:31:08.244462Z", "id": 102025, "queued_at": "2021-01-05T11:31:08.061924Z" } ], "resolved_at": "2021-01-05T11:31:04.000000Z", "sample_size": 1000, "sample_size_unit": "views", "severity": "alert", "started_at": "2021-01-05T09:04:46.000000Z", "status": "closed", "threshold": 5 }, { "affected_views": 132, "affected_views_per_hour": 11, "affected_views_per_hour_on_open": 65, "breakdowns": [ { "id": "abcdef", "name": "video_title", "value": "Layla the dog video 1337" }, { "id": "abcdef", "name": "error_type_id", "value": "697065" } ], "description": "Something else is broken", "error_description": "Detailed error: On no!", "id": "rd9579", "impact": "*132 views* were affected at a rate of *11 per hour*", "incident_key": "fd9add7a85a013d768f4039f9e726133eddb476c2f16b22ebfe56f18f7c03b27", "measured_value": 97, "measured_value_on_close": 1, "measurement": "error_rate", "notification_rules": [], "notifications": [ { "attempted_at": "2020-12-31T09:26:19.416919Z", "id": 102198, "queued_at": "2020-12-31T09:26:18.987717Z" }, { "attempted_at": "2020-12-31T20:23:57.279325Z", "id": 101269, "queued_at": "2020-12-31T20:23:56.997068Z" } ], "resolved_at": "2020-12-31T20:22:54.000000Z", "sample_size": 100, "sample_size_unit": "views", "severity": "alert", "started_at": "2020-12-31T07:56:22.000000Z", "status": "closed", "threshold": 96 } ], "timeframe": [ 1610035979, 1610122379 ], "total_row_count": 2 } } } } } } }, "/data/v1/incidents/{INCIDENT_ID}": { "get": { "tags": [ "Incidents" ], "summary": "Get an Incident", "description": "Returns the details of an incident.", "operationId": "get-incident", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/incident_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentResponse" }, "example": { "data": { "affected_views": 2026, "affected_views_per_hour": 84, "affected_views_per_hour_on_open": 12857, "breakdowns": [ { "id": "abcdef", "name": "error_type_id", "value": "499680" }, { "id": "abcdef", "name": "video_title", "value": "Cute dogs" } ], "description": "This video is erroring a lot", "error_description": "Error Type ID 499680", "id": "g7q2df", "impact": "*2026 views* were affected at a rate of *84 per hour*", "incident_key": "045dfcbefdb68c6003aaf3bf5ed217493772519f28f14d129f95eaff159ea6d6b", "measured_value": 100, "measured_value_on_close": 8, "measurement": "error_rate", "notification_rules": [], "notifications": [ { "attempted_at": "2020-05-14T17:23:08.034662Z", "id": 63293, "queued_at": "2020-05-14T17:23:07.944457Z" }, { "attempted_at": "2020-05-13T17:22:30.444389Z", "id": 62212, "queued_at": "2020-05-13T17:22:30.354828Z" } ], "resolved_at": "2020-05-14T17:22:30.000000Z", "sample_size": 100, "sample_size_unit": "views", "severity": "alert", "started_at": "2020-05-13T17:21:54.000000Z", "status": "closed", "threshold": 100 }, "timeframe": [ 1610036456, 1610122856 ], "total_row_count": 1 } } } } } } }, "/data/v1/incidents/{INCIDENT_ID}/related": { "get": { "tags": [ "Incidents" ], "summary": "List Related Incidents", "description": "Returns all the incidents that seem related to a specific incident.", "operationId": "list-related-incidents", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/incident_id" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/order_by" }, { "$ref": "#/components/parameters/order_direction" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRelatedIncidentsResponse" }, "example": { "data": [ { "affected_views": 71, "affected_views_per_hour": 29, "affected_views_per_hour_on_open": 75, "breakdowns": [ { "id": "abcdef", "name": "error_type_id", "value": "697070" } ], "description": "Something is broken", "error_description": "No seriously, something is really really broken :(", "id": "4u13td", "impact": "*71 views* were affected at a rate of *29 per hour*", "incident_key": "5312a7c0bbb5d8353bd88602f01fe58eb15e9febac8fd2f0d8ce8f1cb138145c", "measured_value": 5.9, "measured_value_on_close": 0.1, "measurement": "error_rate", "notification_rules": [], "notifications": [ { "attempted_at": "2021-01-05T09:52:15.119040Z", "id": 103014, "queued_at": "2021-01-05T09:52:14.945157Z" }, { "attempted_at": "2021-01-05T11:31:08.244462Z", "id": 102025, "queued_at": "2021-01-05T11:31:08.061924Z" } ], "resolved_at": "2021-01-05T11:31:04.000000Z", "sample_size": 1000, "sample_size_unit": "views", "severity": "alert", "started_at": "2021-01-05T09:04:46.000000Z", "status": "closed", "threshold": 5 }, { "affected_views": 132, "affected_views_per_hour": 11, "affected_views_per_hour_on_open": 65, "breakdowns": [ { "id": "abcdef", "name": "video_title", "value": "Layla the dog video 1337" }, { "id": "abcdef", "name": "error_type_id", "value": "697065" } ], "description": "Something else is broken", "error_description": "Detailed error: On no!", "id": "rd9579", "impact": "*132 views* were affected at a rate of *11 per hour*", "incident_key": "fd9add7a85a013d768f4039f9e726133eddb476c2f16b22ebfe56f18f7c03b27", "measured_value": 97, "measured_value_on_close": 1, "measurement": "error_rate", "notification_rules": [], "notifications": [ { "attempted_at": "2020-12-31T09:26:19.416919Z", "id": 102198, "queued_at": "2020-12-31T09:26:18.987717Z" }, { "attempted_at": "2020-12-31T20:23:57.279325Z", "id": 101269, "queued_at": "2020-12-31T20:23:56.997068Z" } ], "resolved_at": "2020-12-31T20:22:54.000000Z", "sample_size": 100, "sample_size_unit": "views", "severity": "alert", "started_at": "2020-12-31T07:56:22.000000Z", "status": "closed", "threshold": 96 } ], "timeframe": [ 1610035979, 1610122379 ], "total_row_count": 2 } } } } } } }, "/data/v1/annotations": { "get": { "tags": [ "Annotations" ], "summary": "List Annotations", "description": "Returns a list of annotations.", "operationId": "list-annotations", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/order_direction" }, { "$ref": "#/components/parameters/timeframe" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAnnotationsResponse" }, "example": { "data": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "note": "This is one note", "date": "2025-04-23T19:10:00Z", "sub_property_id": "123456" }, { "id": "234e4567-e89b-12d3-a456-426614174000", "note": "This is another note", "date": "2025-04-23T19:20:00Z", "sub_property_id": null } ], "total_row_count": 2, "timeframe": [ 1745434800, 1745438400 ] } } } } } }, "post": { "tags": [ "Annotations" ], "summary": "Create Annotation", "description": "Creates a new annotation.", "operationId": "create-annotation", "servers": [ { "url": "https://api.mux.com" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationInput" }, "example": { "note": "This is a note", "date": 1745438400, "sub_property_id": "123456" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationResponse" }, "example": { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "note": "This is a note", "date": "2025-04-23T20:00:00Z", "sub_property_id": "123456" }, "total_row_count": 1, "timeframe": [ 1745434800, 1745438400 ] } } } } } } }, "/data/v1/annotations/{ANNOTATION_ID}": { "get": { "tags": [ "Annotations" ], "summary": "Get Annotation", "description": "Returns the details of a specific annotation.", "operationId": "get-annotation", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/annotation_id" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationResponse" }, "example": { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "note": "This is a note", "date": "2025-04-23T19:10:00Z", "sub_property_id": "123456" }, "total_row_count": 1, "timeframe": [ 1745434800, 1745438400 ] } } } } } }, "patch": { "tags": [ "Annotations" ], "summary": "Update Annotation", "description": "Updates an existing annotation.", "operationId": "update-annotation", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/annotation_id" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationInput" }, "example": { "note": "This is a note", "date": 1745438400, "sub_property_id": "123456" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationResponse" }, "example": { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "note": "This is a note", "date": "2025-04-23T20:00:00Z", "sub_property_id": "123456" }, "total_row_count": 1, "timeframe": [ 1745434800, 1745438400 ] } } } } } }, "delete": { "tags": [ "Annotations" ], "summary": "Delete Annotation", "description": "Deletes an annotation.", "operationId": "delete-annotation", "servers": [ { "url": "https://api.mux.com" } ], "parameters": [ { "$ref": "#/components/parameters/annotation_id" } ], "responses": { "204": { "description": "No Content" } } } } }, "components": { "parameters": { "limit": { "name": "limit", "in": "query", "description": "Number of items to include in the response", "required": false, "schema": { "type": "integer", "format": "int32", "default": 25 } }, "page": { "name": "page", "in": "query", "description": "Offset by this many pages, of the size of `limit`", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1 } }, "viewer_id": { "name": "viewer_id", "in": "query", "description": "Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.", "required": false, "schema": { "type": "string" } }, "error_id": { "name": "error_id", "in": "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.", "required": false, "schema": { "type": "integer", "format": "int32" } }, "order_direction": { "name": "order_direction", "in": "query", "description": "Sort order.", "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "filters": { "name": "filters[]", "in": "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", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "metric_filters": { "name": "metric_filters[]", "in": "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", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "timeframe": { "name": "timeframe[]", "in": "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", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "video_view_id": { "name": "VIDEO_VIEW_ID", "in": "path", "description": "ID of the Video View", "required": true, "example": "abcd1234", "schema": { "type": "string" } }, "filter_id": { "name": "FILTER_ID", "in": "path", "description": "ID of the Filter", "required": true, "example": "abcd1234", "schema": { "type": "string" } }, "dimension_id": { "name": "DIMENSION_ID", "in": "path", "description": "ID of the Dimension", "required": true, "example": "abcd1234", "schema": { "type": "string" } }, "order_by": { "name": "order_by", "in": "query", "description": "Value to order the results by", "required": false, "schema": { "type": "string", "enum": [ "negative_impact", "value", "views", "field" ] } }, "metric_id": { "name": "METRIC_ID", "in": "path", "description": "ID of the Metric", "required": true, "example": "video_startup_time", "schema": { "type": "string", "enum": [ "aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_request_latency", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_success_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "request_latency", "request_throughput", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage", "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "playback_business_exception_percentage", "video_startup_business_exception_percentage", "view_content_startup_time", "ad_preroll_startup_time", "view_dropped_percentage", "rendition_change_count", "rendition_upshift_count", "rendition_downshift_count" ] } }, "group_by": { "name": "group_by", "in": "query", "description": "Breakdown value to group the results by", "required": false, "schema": { "type": "string", "enum": [ "asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "page_url", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_business_exception", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin", "video_creator_id", "video_cdn_trace", "video_source_height_initial", "video_source_width_initial", "video_source_bitrate_initial", "video_codec_initial", "audio_codec_initial", "video_source_fps_initial", "video_dynamic_range_type_initial", "video_source_fps", "video_source_bitrate", "video_source_height", "video_source_width" ] } }, "measurement": { "name": "measurement", "in": "query", "description": "Measurement for the provided metric. If omitted, the default for the metric will be used.\nThe default measurement for each metric is:\n\"sum\" : `ad_attempt_count`, `ad_break_count`, `ad_break_error_count`, `ad_error_count`, `ad_impression_count`, `playing_time`\n\"median\" : `ad_preroll_startup_time`, `aggregate_startup_time`, `content_startup_time`, `max_downscale_percentage`, `max_upscale_percentage`, `page_load_time`, `player_average_live_latency`, `player_startup_time`, `rebuffer_count`, `rebuffer_duration`, `requests_for_first_preroll`, `video_startup_preroll_load_time`, `video_startup_preroll_request_time`, `video_startup_time`, `view_average_request_latency`, `view_average_request_throughput`, `view_max_request_latency`, `weighted_average_bitrate`\n\"avg\" : `ad_break_error_percentage`, `ad_error_percentage`, `ad_exit_before_start_count`, `ad_exit_before_start_percentage`, `ad_playback_failure_percentage`, `ad_startup_error_count`, `ad_startup_error_percentage`, `content_playback_failure_percentage`, `downscale_percentage`, `exits_before_video_start`, `playback_business_exception_percentage`, `playback_failure_percentage`, `playback_success_score`, `rebuffer_frequency`, `rebuffer_percentage`, `seek_latency`, `smoothness_score`, `startup_time_score`, `upscale_percentage`, `video_quality_score`, `video_startup_business_exception_percentage`, `video_startup_failure_percentage`, `view_dropped_percentage`, `viewer_experience_score`\n\"count\" : `started_views`, `unique_viewers`\n", "required": false, "schema": { "type": "string", "enum": [ "95th", "median", "avg", "count", "sum" ] } }, "order_direction_deprecated": { "name": "order_direction", "in": "query", "description": "Sort order.", "deprecated": true, "required": false, "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "timeseries_group_by": { "name": "group_by", "in": "query", "description": "Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe.\n\nFor timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.\n", "required": false, "schema": { "type": "string", "enum": [ "minute", "ten_minutes", "hour", "day" ] } }, "dimension": { "name": "dimension", "in": "query", "description": "Dimension the specified value belongs to", "required": false, "schema": { "type": "string", "enum": [ "asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "page_type", "page_url", "playback_failure", "playback_business_exception", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_content_type", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_startup_business_exception", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id", "ad_playback_failure", "content_playback_failure", "view_dropped", "client_application_name", "client_application_version", "video_affiliate", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "view_drm_level", "video_brand", "used_pip", "time_shift_enabled", "used_captions", "video_codec", "audio_codec", "video_dynamic_range_type", "view_cdn_edge_pop", "view_cdn_origin", "video_creator_id", "video_cdn_trace" ] } }, "value": { "name": "value", "in": "query", "description": "Value to show all available metrics for", "required": false, "schema": { "type": "string" } }, "monitoring_metric_id": { "name": "MONITORING_METRIC_ID", "in": "path", "description": "ID of the Monitoring Metric", "required": true, "example": "current-concurrent-viewers", "schema": { "type": "string", "enum": [ "current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage" ] } }, "monitoring_dimension": { "name": "dimension", "in": "query", "description": "Dimension the specified value belongs to", "required": false, "schema": { "type": "string", "enum": [ "asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title", "view_has_ad" ] } }, "timestamp": { "name": "timestamp", "in": "query", "description": "Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.", "required": false, "schema": { "type": "integer", "format": "int32" } }, "monitoring_filters": { "name": "filters[]", "in": "query", "description": "Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.\n\nTo exclude rows that match a certain condition, prepend a `!` character to the dimension.\n\nPossible filter names are the same as returned by the List Monitoring Dimensions endpoint.\n\nExample:\n\n * `filters[]=operating_system:windows&filters[]=!country:US`\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "monitoring_timeseries_timeframe": { "name": "timeframe[]", "in": "query", "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nThe default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, "monitoring_timeseries_limit": { "name": "limit", "in": "query", "description": "Number of items to include in each timestamp's `value` list.\n\nThe default is 10, and the maximum is 100.\n", "required": false, "schema": { "type": "integer", "format": "int32", "default": 10 } }, "monitoring_histogram_metric_id": { "name": "MONITORING_HISTOGRAM_METRIC_ID", "in": "path", "description": "ID of the Monitoring Histogram Metric", "required": true, "example": "video-startup-time", "schema": { "type": "string", "enum": [ "video-startup-time" ] } }, "monitoring_timeseries_timestamp": { "name": "timestamp", "in": "query", "description": "Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.", "required": false, "schema": { "type": "integer", "format": "int32" } }, "realtime_metric_id": { "name": "REALTIME_METRIC_ID", "in": "path", "description": "ID of the Realtime Metric", "required": true, "example": "current-concurrent-viewers", "schema": { "type": "string", "enum": [ "current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate" ] } }, "realtime_dimension": { "name": "dimension", "in": "query", "description": "Dimension the specified value belongs to", "required": false, "schema": { "type": "string", "enum": [ "asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title" ] } }, "realtime_histogram_metric_id": { "name": "REALTIME_HISTOGRAM_METRIC_ID", "in": "path", "description": "ID of the Realtime Histogram Metric", "required": true, "example": "video-startup-time", "schema": { "type": "string", "enum": [ "video-startup-time" ] } }, "incident_status": { "name": "status", "in": "query", "description": "Status to filter incidents by", "required": false, "schema": { "type": "string", "enum": [ "open", "closed", "expired" ] } }, "severity": { "name": "severity", "in": "query", "description": "Severity to filter incidents by", "required": false, "schema": { "type": "string", "enum": [ "warning", "alert" ] } }, "incident_id": { "name": "INCIDENT_ID", "in": "path", "description": "ID of the Incident", "required": true, "example": "abcd1234", "schema": { "type": "string" } }, "annotation_id": { "name": "ANNOTATION_ID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" }, "description": "The annotation ID" } }, "schemas": { "ListVideoViewsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AbridgedVideoView" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "AbridgedVideoView": { "type": "object", "properties": { "id": { "type": "string" }, "viewer_os_family": { "type": "string", "nullable": true }, "viewer_application_name": { "type": "string", "nullable": true }, "video_title": { "type": "string", "nullable": true }, "total_row_count": { "type": "integer", "format": "int64" }, "player_error_message": { "type": "string", "nullable": true }, "player_error_code": { "type": "string", "nullable": true }, "error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "view_start": { "type": "string" }, "view_end": { "type": "string" }, "viewer_experience_score": { "type": "number", "format": "float", "nullable": true }, "watch_time": { "type": "integer", "format": "int32", "nullable": true }, "playback_failure": { "type": "boolean" } }, "required": [ "id", "viewer_os_family", "viewer_application_name", "video_title", "total_row_count", "player_error_message", "player_error_code", "error_type_id", "country_code", "view_start", "view_end", "viewer_experience_score", "watch_time", "playback_failure" ] }, "VideoViewResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VideoView" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true } }, "required": [ "data", "timeframe", "total_row_count" ] }, "VideoView": { "type": "object", "properties": { "view_total_upscaling": { "type": "string", "nullable": true }, "preroll_ad_asset_hostname": { "type": "string", "nullable": true }, "player_source_domain": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "viewer_user_agent": { "type": "string", "nullable": true }, "preroll_requested": { "type": "boolean", "nullable": true }, "page_type": { "type": "string", "nullable": true }, "startup_score": { "type": "string", "nullable": true }, "view_seek_duration": { "type": "integer", "format": "int64", "nullable": true }, "country_name": { "type": "string", "nullable": true }, "player_source_height": { "type": "integer", "format": "int32", "nullable": true }, "longitude": { "type": "string", "nullable": true }, "buffering_count": { "type": "integer", "format": "int64", "nullable": true }, "video_duration": { "type": "integer", "format": "int64", "nullable": true }, "player_source_type": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "view_id": { "type": "string" }, "platform_description": { "type": "string", "nullable": true }, "video_startup_preroll_request_time": { "type": "integer", "format": "int64", "nullable": true }, "viewer_device_name": { "type": "string", "nullable": true }, "video_series": { "type": "string", "nullable": true }, "viewer_application_name": { "type": "string", "nullable": true }, "updated_at": { "type": "string" }, "view_total_content_playback_time": { "type": "integer", "format": "int64", "nullable": true }, "cdn": { "type": "string", "nullable": true }, "player_instance_id": { "type": "string", "nullable": true }, "video_language": { "type": "string", "nullable": true }, "player_source_width": { "type": "integer", "format": "int32", "nullable": true }, "player_error_message": { "type": "string", "nullable": true }, "player_mux_plugin_version": { "type": "string", "nullable": true }, "watched": { "type": "boolean" }, "playback_score": { "type": "string", "nullable": true }, "page_url": { "type": "string", "nullable": true }, "metro": { "type": "string", "nullable": true }, "view_max_request_latency": { "type": "integer", "format": "int64", "nullable": true }, "requests_for_first_preroll": { "type": "integer", "format": "int64", "nullable": true }, "view_total_downscaling": { "type": "string", "nullable": true }, "latitude": { "type": "string", "nullable": true }, "player_source_host_name": { "type": "string", "nullable": true }, "inserted_at": { "type": "string" }, "view_end": { "type": "string" }, "mux_embed_version": { "type": "string", "nullable": true }, "player_language": { "type": "string", "nullable": true }, "page_load_time": { "type": "integer", "format": "int64", "nullable": true }, "viewer_device_category": { "type": "string", "nullable": true }, "video_startup_preroll_load_time": { "type": "integer", "format": "int64", "nullable": true }, "player_version": { "type": "string", "nullable": true }, "watch_time": { "type": "integer", "format": "int64", "nullable": true }, "player_source_stream_type": { "type": "string", "nullable": true }, "preroll_ad_tag_hostname": { "type": "string", "nullable": true }, "viewer_device_manufacturer": { "type": "string", "nullable": true }, "rebuffering_score": { "type": "string", "nullable": true }, "experiment_name": { "type": "string", "nullable": true }, "viewer_os_version": { "type": "string", "nullable": true }, "player_preload": { "type": "boolean" }, "buffering_duration": { "type": "integer", "format": "int64", "nullable": true }, "player_view_count": { "type": "integer", "format": "int64", "nullable": true }, "player_software": { "type": "string", "nullable": true }, "player_load_time": { "type": "integer", "format": "int64", "nullable": true }, "platform_summary": { "type": "string", "nullable": true }, "video_encoding_variant": { "type": "string", "nullable": true }, "player_width": { "type": "integer", "format": "int32", "nullable": true }, "view_seek_count": { "type": "integer", "format": "int64", "nullable": true }, "viewer_experience_score": { "type": "string", "nullable": true }, "view_error_id": { "type": "integer", "format": "int32", "nullable": true }, "video_variant_name": { "type": "string", "nullable": true }, "preroll_played": { "type": "boolean", "nullable": true }, "viewer_application_engine": { "type": "string", "nullable": true }, "viewer_os_architecture": { "type": "string", "nullable": true }, "player_error_code": { "type": "string", "nullable": true }, "buffering_rate": { "type": "string", "nullable": true }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/VideoViewEvent" } }, "player_name": { "type": "string", "nullable": true }, "view_start": { "type": "string" }, "view_average_request_throughput": { "type": "integer", "format": "int64", "nullable": true }, "video_producer": { "type": "string", "nullable": true }, "error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "mux_viewer_id": { "type": "string" }, "video_id": { "type": "string", "nullable": true }, "continent_code": { "type": "string", "nullable": true }, "session_id": { "type": "string" }, "exit_before_video_start": { "type": "boolean" }, "video_content_type": { "type": "string", "nullable": true }, "viewer_os_family": { "type": "string", "nullable": true }, "player_poster": { "type": "string", "nullable": true }, "view_average_request_latency": { "type": "integer", "format": "int64", "nullable": true }, "video_variant_id": { "type": "string", "nullable": true }, "player_source_duration": { "type": "integer", "format": "int64", "nullable": true }, "player_source_url": { "type": "string", "nullable": true }, "mux_api_version": { "type": "string" }, "video_title": { "type": "string", "nullable": true }, "id": { "type": "string" }, "short_time": { "type": "string" }, "rebuffer_percentage": { "type": "string", "nullable": true }, "time_to_first_frame": { "type": "integer", "format": "int64", "nullable": true }, "viewer_user_id": { "type": "string", "nullable": true }, "video_stream_type": { "type": "string", "nullable": true }, "player_startup_time": { "type": "integer", "format": "int64", "nullable": true }, "viewer_application_version": { "type": "string", "nullable": true }, "view_max_downscale_percentage": { "type": "string", "nullable": true }, "view_max_upscale_percentage": { "type": "string", "nullable": true }, "country_code": { "type": "string", "nullable": true }, "used_fullscreen": { "type": "boolean" }, "isp": { "type": "string", "nullable": true }, "property_id": { "type": "integer", "format": "int64" }, "player_autoplay": { "type": "boolean" }, "player_height": { "type": "integer", "format": "int32", "nullable": true }, "asn": { "type": "integer", "format": "int64", "nullable": true }, "asn_name": { "type": "string", "nullable": true }, "quality_score": { "type": "string", "nullable": true }, "player_software_version": { "type": "string", "nullable": true }, "player_mux_plugin_name": { "type": "string", "nullable": true }, "sub_property_id": { "type": "string", "nullable": true }, "player_remote_played": { "type": "boolean", "nullable": true }, "view_max_playhead_position": { "type": "string", "nullable": true }, "view_playing_time": { "type": "string", "nullable": true }, "view_session_id": { "type": "string", "nullable": true }, "viewer_connection_type": { "type": "string", "nullable": true }, "viewer_device_model": { "type": "string", "nullable": true }, "weighted_average_bitrate": { "type": "number", "format": "double", "nullable": true }, "custom_1": { "type": "string", "nullable": true }, "custom_2": { "type": "string", "nullable": true }, "custom_3": { "type": "string", "nullable": true }, "custom_4": { "type": "string", "nullable": true }, "custom_5": { "type": "string", "nullable": true }, "custom_6": { "type": "string", "nullable": true }, "custom_7": { "type": "string", "nullable": true }, "custom_8": { "type": "string", "nullable": true }, "custom_9": { "type": "string", "nullable": true }, "custom_10": { "type": "string", "nullable": true }, "live_stream_latency": { "type": "integer", "format": "int64", "nullable": true }, "asset_id": { "type": "string", "nullable": true }, "environment_id": { "type": "string" }, "live_stream_id": { "type": "string", "nullable": true }, "mux_embed": { "type": "string", "nullable": true }, "playback_id": { "type": "string", "nullable": true }, "player_error_context": { "type": "string", "nullable": true }, "view_drm_type": { "type": "string", "nullable": true }, "view_dropped_frame_count": { "type": "integer", "format": "int64", "nullable": true }, "view_has_ad": { "type": "boolean" }, "video_startup_failure": { "type": "boolean" }, "ad_attempt_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_break_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_break_error_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_break_error_percentage": { "type": "string", "nullable": true }, "ad_error_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_error_percentage": { "type": "string", "nullable": true }, "ad_impression_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_startup_error_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_startup_error_percentage": { "type": "string", "nullable": true }, "ad_exit_before_start_count": { "type": "integer", "format": "int32", "nullable": true }, "ad_exit_before_start_percentage": { "type": "string", "nullable": true }, "rendition_change_count": { "type": "integer", "format": "int32", "nullable": true }, "rendition_upshift_count": { "type": "integer", "format": "int32", "nullable": true }, "rendition_downshift_count": { "type": "integer", "format": "int32", "nullable": true }, "long_resume": { "type": "boolean" }, "long_rebuffering": { "type": "boolean" }, "playback_failure_error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "playback_business_exception_error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "video_startup_business_exception_error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "playback_failure": { "type": "boolean" }, "ad_playback_failure_error_type_id": { "type": "integer", "format": "int32", "nullable": true }, "view_content_startup_time": { "type": "integer", "format": "int32", "nullable": true }, "ad_preroll_startup_time": { "type": "integer", "format": "int32", "nullable": true }, "view_dropped": { "type": "boolean" }, "client_application_name": { "type": "string", "nullable": true }, "client_application_version": { "type": "string", "nullable": true }, "video_affiliate": { "type": "string", "nullable": true }, "viewer_plan": { "type": "string", "nullable": true }, "viewer_plan_status": { "type": "string", "nullable": true }, "viewer_plan_category": { "type": "string", "nullable": true }, "view_drm_level": { "type": "string", "nullable": true }, "video_brand": { "type": "string", "nullable": true }, "used_pip": { "type": "boolean" }, "time_shift_enabled": { "type": "boolean" }, "used_captions": { "type": "boolean" }, "video_codec": { "type": "string", "nullable": true }, "audio_codec": { "type": "string", "nullable": true }, "video_dynamic_range_type": { "type": "string", "nullable": true }, "video_source_height_initial": { "type": "integer", "format": "int32", "nullable": true }, "video_source_width_initial": { "type": "integer", "format": "int32", "nullable": true }, "video_source_bitrate_initial": { "type": "integer", "format": "int64", "nullable": true }, "video_codec_initial": { "type": "string", "nullable": true }, "audio_codec_initial": { "type": "string", "nullable": true }, "video_source_fps_initial": { "type": "number", "format": "double", "nullable": true }, "video_dynamic_range_type_initial": { "type": "string", "nullable": true }, "video_source_fps": { "type": "number", "format": "double", "nullable": true }, "video_source_bitrate": { "type": "integer", "format": "int64", "nullable": true }, "video_source_height": { "type": "integer", "format": "int32", "nullable": true }, "video_source_width": { "type": "integer", "format": "int32", "nullable": true }, "view_cdn_edge_pop": { "type": "string", "nullable": true }, "view_cdn_origin": { "type": "string", "nullable": true }, "video_creator_id": { "type": "string", "nullable": true }, "video_cdn_trace": { "type": "array", "items": { "type": "string" } } }, "required": [ "ad_attempt_count", "ad_break_count", "ad_break_error_count", "ad_break_error_percentage", "ad_error_count", "ad_error_percentage", "ad_exit_before_start_count", "ad_exit_before_start_percentage", "ad_impression_count", "ad_startup_error_count", "ad_startup_error_percentage", "rendition_change_count", "rendition_upshift_count", "rendition_downshift_count", "asn", "asn_name", "asset_id", "audio_codec", "buffering_count", "buffering_duration", "buffering_rate", "cdn", "city", "client_application_name", "client_application_version", "continent_code", "country_code", "country_name", "custom_1", "custom_10", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "environment_id", "error_type_id", "events", "exit_before_video_start", "experiment_name", "id", "inserted_at", "isp", "latitude", "live_stream_id", "live_stream_latency", "long_rebuffering", "long_resume", "longitude", "metro", "mux_api_version", "mux_embed", "mux_embed_version", "mux_viewer_id", "page_load_time", "page_type", "page_url", "platform_description", "platform_summary", "playback_id", "playback_score", "player_autoplay", "player_error_code", "player_error_message", "player_height", "player_instance_id", "player_language", "player_load_time", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_poster", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_source_domain", "player_source_duration", "player_source_height", "player_source_host_name", "player_source_stream_type", "player_source_type", "player_source_url", "player_source_width", "player_startup_time", "player_version", "player_view_count", "player_width", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "property_id", "quality_score", "rebuffer_percentage", "rebuffering_score", "region", "requests_for_first_preroll", "session_id", "short_time", "startup_score", "sub_property_id", "time_shift_enabled", "time_to_first_frame", "updated_at", "used_captions", "used_fullscreen", "used_pip", "video_affiliate", "video_brand", "video_cdn_trace", "video_codec", "video_content_type", "video_creator_id", "video_duration", "video_dynamic_range_type", "video_source_height_initial", "video_source_width_initial", "video_source_bitrate_initial", "video_codec_initial", "audio_codec_initial", "video_source_fps_initial", "video_dynamic_range_type_initial", "video_source_fps", "video_source_bitrate", "video_source_height", "video_source_width", "video_encoding_variant", "video_id", "video_language", "video_producer", "video_series", "video_startup_failure", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_stream_type", "video_title", "video_variant_id", "video_variant_name", "view_average_request_latency", "view_average_request_throughput", "view_cdn_edge_pop", "view_cdn_origin", "view_drm_level", "view_drm_type", "view_dropped", "view_dropped_frame_count", "view_end", "view_error_id", "view_has_ad", "view_id", "view_max_downscale_percentage", "view_max_playhead_position", "view_max_request_latency", "view_max_upscale_percentage", "view_playing_time", "view_seek_count", "view_seek_duration", "view_session_id", "view_start", "view_total_content_playback_time", "view_total_downscaling", "view_total_upscaling", "viewer_application_engine", "viewer_application_name", "viewer_application_version", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_experience_score", "viewer_os_architecture", "viewer_os_family", "viewer_os_version", "viewer_plan", "viewer_plan_status", "viewer_plan_category", "viewer_user_agent", "viewer_user_id", "watch_time", "watched", "weighted_average_bitrate", "playback_failure_error_type_id", "playback_business_exception_error_type_id", "video_startup_business_exception_error_type_id", "playback_failure", "ad_playback_failure_error_type_id", "view_content_startup_time", "ad_preroll_startup_time" ] }, "VideoViewEvent": { "type": "object", "properties": { "viewer_time": { "type": "integer", "format": "int64" }, "playback_time": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "event_time": { "type": "integer", "format": "int64" }, "details": { "type": "object", "additionalProperties": true } }, "required": [ "viewer_time", "playback_time", "name", "event_time", "details" ] }, "ListErrorsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "Error": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "A unique identifier for this error." }, "percentage": { "type": "number", "format": "double", "description": "The percentage of views that experienced this error." }, "notes": { "type": "string", "description": "Notes that are attached to this error.", "nullable": true }, "message": { "type": "string", "description": "The error message.", "nullable": true }, "last_seen": { "type": "string", "description": "The last time this error was seen (ISO 8601 timestamp)." }, "description": { "type": "string", "description": "Description of the error.", "nullable": true }, "count": { "type": "integer", "format": "int64", "description": "The total number of views that experienced this error." }, "code": { "type": "integer", "format": "int64", "description": "The error code", "nullable": true }, "player_error_code": { "type": "string", "nullable": true, "description": "The string version of the error code" } }, "required": [ "id", "percentage", "notes", "message", "last_seen", "description", "count", "code", "player_error_code" ] }, "ListFiltersResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "basic": { "type": "array", "items": { "type": "string" } }, "advanced": { "type": "array", "items": { "type": "string" } } }, "required": [ "basic", "advanced" ] }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "ListFilterValuesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FilterValue" } }, "total_row_count": { "type": "integer", "format": "int64" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "FilterValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "total_count": { "type": "integer", "format": "int64" } }, "required": [ "value", "total_count" ] }, "ListDimensionsResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "basic": { "type": "array", "items": { "type": "string" } }, "advanced": { "type": "array", "items": { "type": "string" } } }, "required": [ "basic", "advanced" ] }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "ListDimensionValuesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DimensionValue" } }, "total_row_count": { "type": "integer", "format": "int64" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "DimensionValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "total_count": { "type": "integer", "format": "int64" } }, "required": [ "value", "total_count" ] }, "ListExportsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "ListVideoViewExportsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExportDate" } }, "total_row_count": { "type": "integer", "format": "int32", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "required": [ "data", "total_row_count", "timeframe" ] }, "ExportDate": { "type": "object", "properties": { "export_date": { "type": "string", "format": "date" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/ExportFile" } } }, "required": [ "export_date", "files" ] }, "ExportFile": { "type": "object", "properties": { "version": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "path": { "type": "string" } }, "required": [ "version", "type", "path" ] }, "ListBreakdownValuesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownValue" } }, "total_row_count": { "type": "integer", "format": "int64" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "meta": { "type": "object", "properties": { "granularity": { "type": "string" }, "aggregation": { "type": "string" } } } }, "required": [ "data", "total_row_count", "timeframe", "meta" ] }, "BreakdownValue": { "type": "object", "properties": { "views": { "type": "integer", "format": "int64" }, "value": { "type": "number", "format": "double" }, "total_watch_time": { "type": "integer", "format": "int64", "nullable": true }, "total_playing_time": { "type": "integer", "format": "int64", "nullable": true }, "negative_impact": { "type": "integer", "format": "int32" }, "field": { "type": "string", "nullable": true } }, "required": [ "field", "value", "views", "negative_impact", "total_watch_time", "total_playing_time" ] }, "GetOverallValuesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/OverallValues" }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "meta": { "type": "object", "properties": { "granularity": { "type": "string" }, "aggregation": { "type": "string" } } } }, "required": [ "data", "timeframe", "total_row_count", "meta" ] }, "OverallValues": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "total_watch_time": { "type": "integer", "format": "int64", "nullable": true }, "total_views": { "type": "integer", "format": "int64" }, "total_playing_time": { "type": "integer", "format": "int64", "nullable": true }, "global_value": { "type": "number", "format": "double", "nullable": true } }, "required": [ "value", "total_watch_time", "total_views", "total_playing_time", "global_value" ] }, "ListInsightsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Insight" } }, "total_row_count": { "type": "integer", "format": "int64" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "meta": { "type": "object", "properties": { "granularity": { "type": "string" }, "aggregation": { "type": "string" } } } }, "required": [ "data", "timeframe", "total_row_count", "meta" ] }, "Insight": { "type": "object", "properties": { "total_watch_time": { "type": "integer", "format": "int64", "nullable": true }, "total_playing_time": { "type": "integer", "format": "int64", "nullable": true }, "total_views": { "type": "integer", "format": "int64" }, "negative_impact_score": { "type": "number", "format": "float" }, "metric": { "type": "number", "format": "double" }, "filter_value": { "type": "string", "nullable": true }, "filter_column": { "type": "string" } }, "required": [ "total_watch_time", "total_playing_time", "total_views", "negative_impact_score", "metric", "filter_value", "filter_column" ] }, "GetMetricTimeseriesDataResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "integer", "format": "int64", "nullable": true }, { "type": "number", "format": "double", "nullable": true } ] } } }, "total_row_count": { "type": "integer", "format": "int64" }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "meta": { "type": "object", "properties": { "granularity": { "type": "string" }, "aggregation": { "type": "string" } } } }, "required": [ "data", "timeframe", "total_row_count", "meta" ] }, "ListAllMetricValuesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Score" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "Score": { "type": "object", "properties": { "watch_time": { "type": "integer", "format": "int64", "nullable": true }, "view_count": { "type": "integer", "format": "int64" }, "unique_viewers": { "type": "integer", "format": "int64" }, "started_views": { "type": "integer", "format": "int64" }, "total_playing_time": { "type": "integer", "format": "int64", "nullable": true }, "name": { "type": "string" }, "ended_views": { "type": "integer", "format": "int64" }, "value": { "type": "number", "format": "double" }, "type": { "type": "string" }, "metric": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Metric" } } }, "required": [ "name" ] }, "Metric": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "type": { "type": "string" }, "name": { "type": "string" }, "metric": { "type": "string" }, "measurement": { "type": "string" } }, "required": [ "name", "value", "type", "metric" ] }, "ListMonitoringDimensionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" } }, "required": [ "name", "display_name" ] } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "ListMonitoringMetricsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" } }, "required": [ "name", "display_name" ] } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "GetMonitoringBreakdownResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringBreakdownValue" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "MonitoringBreakdownValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "negative_impact": { "type": "integer", "format": "int64" }, "metric_value": { "type": "number", "format": "double", "nullable": true }, "display_value": { "type": "string" }, "concurrent_viewers": { "type": "integer", "format": "int64" }, "starting_up_viewers": { "type": "integer", "format": "int64" } }, "required": [ "value", "negative_impact", "metric_value", "concurrent_viewers", "starting_up_viewers" ] }, "GetMonitoringBreakdownTimeseriesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringBreakdownTimeseriesValues" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "MonitoringBreakdownTimeseriesValues": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringBreakdownTimeseriesDatapoint" } }, "date": { "type": "string" } }, "required": [ "values", "date" ] }, "MonitoringBreakdownTimeseriesDatapoint": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "metric_value": { "type": "number", "format": "double", "nullable": true }, "concurrent_viewers": { "type": "integer", "format": "int64" }, "starting_up_viewers": { "type": "integer", "format": "int64" } }, "required": [ "value", "metric_value", "concurrent_viewers", "starting_up_viewers" ] }, "GetMonitoringHistogramTimeseriesResponse": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "bucket_unit": { "type": "string" }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringHistogramTimeseriesBucket" } } }, "required": [ "bucket_unit", "buckets" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringHistogramTimeseriesDatapoint" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "meta", "data", "timeframe", "total_row_count" ] }, "MonitoringHistogramTimeseriesBucket": { "type": "object", "properties": { "start": { "type": "integer", "format": "int64" }, "end": { "type": "integer", "format": "int64", "nullable": true } }, "required": [ "start", "end" ] }, "MonitoringHistogramTimeseriesDatapoint": { "type": "object", "properties": { "timestamp": { "type": "string" }, "sum": { "type": "integer", "format": "int64" }, "p95": { "type": "number", "format": "double", "nullable": true }, "median": { "type": "number", "format": "double", "nullable": true }, "max_percentage": { "type": "number", "format": "double" }, "bucket_values": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringHistogramTimeseriesBucketValues" } }, "average": { "type": "number", "format": "double", "nullable": true } }, "required": [ "timestamp", "sum", "p95", "median", "max_percentage", "bucket_values", "average" ] }, "MonitoringHistogramTimeseriesBucketValues": { "type": "object", "properties": { "percentage": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int64" } }, "required": [ "percentage", "count" ] }, "GetMonitoringTimeseriesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MonitoringTimeseriesDatapoint" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "MonitoringTimeseriesDatapoint": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "date": { "type": "string" }, "concurrent_viewers": { "type": "integer", "format": "int64" } }, "required": [ "value", "date", "concurrent_viewers" ] }, "ListRealTimeDimensionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" } }, "required": [ "name", "display_name" ] } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "ListRealTimeMetricsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "display_name": { "type": "string" } }, "required": [ "name", "display_name" ] } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "GetRealTimeBreakdownResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeBreakdownValue" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "RealTimeBreakdownValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "negative_impact": { "type": "integer", "format": "int64" }, "metric_value": { "type": "number", "format": "double", "nullable": true }, "display_value": { "type": "string" }, "concurrent_viewers": { "type": "integer", "format": "int64" }, "starting_up_viewers": { "type": "integer", "format": "int64" } }, "required": [ "value", "negative_impact", "metric_value", "concurrent_viewers", "starting_up_viewers" ] }, "GetRealTimeHistogramTimeseriesResponse": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "bucket_unit": { "type": "string" }, "buckets": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeHistogramTimeseriesBucket" } } }, "required": [ "bucket_unit", "buckets" ] }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeHistogramTimeseriesDatapoint" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "meta", "data", "timeframe", "total_row_count" ] }, "RealTimeHistogramTimeseriesBucket": { "type": "object", "properties": { "start": { "type": "integer", "format": "int64" }, "end": { "type": "integer", "format": "int64", "nullable": true } }, "required": [ "start", "end" ] }, "RealTimeHistogramTimeseriesDatapoint": { "type": "object", "properties": { "timestamp": { "type": "string" }, "sum": { "type": "integer", "format": "int64" }, "p95": { "type": "number", "format": "double", "nullable": true }, "median": { "type": "number", "format": "double", "nullable": true }, "max_percentage": { "type": "number", "format": "double" }, "bucket_values": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeHistogramTimeseriesBucketValues" } }, "average": { "type": "number", "format": "double", "nullable": true } }, "required": [ "timestamp", "sum", "p95", "median", "max_percentage", "bucket_values", "average" ] }, "RealTimeHistogramTimeseriesBucketValues": { "type": "object", "properties": { "percentage": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int64" } }, "required": [ "percentage", "count" ] }, "GetRealTimeTimeseriesResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RealTimeTimeseriesDatapoint" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "RealTimeTimeseriesDatapoint": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "date": { "type": "string" }, "concurrent_viewers": { "type": "integer", "format": "int64" } }, "required": [ "value", "date", "concurrent_viewers" ] }, "ListIncidentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "Incident": { "type": "object", "properties": { "threshold": { "type": "number", "format": "double" }, "status": { "type": "string" }, "started_at": { "type": "string" }, "severity": { "type": "string" }, "sample_size_unit": { "type": "string" }, "sample_size": { "type": "integer", "format": "int64" }, "resolved_at": { "type": "string", "nullable": true }, "notifications": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentNotification" } }, "notification_rules": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentNotificationRule" } }, "measurement": { "type": "string" }, "measured_value_on_close": { "type": "number", "format": "double", "nullable": true }, "measured_value": { "type": "number", "format": "double", "nullable": true }, "incident_key": { "type": "string" }, "impact": { "type": "string" }, "id": { "type": "string" }, "error_description": { "type": "string" }, "description": { "type": "string" }, "breakdowns": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentBreakdown" } }, "affected_views_per_hour_on_open": { "type": "integer", "format": "int64" }, "affected_views_per_hour": { "type": "integer", "format": "int64" }, "affected_views": { "type": "integer", "format": "int64" } }, "required": [ "id", "started_at", "resolved_at", "incident_key", "measurement", "measured_value", "measured_value_on_close", "sample_size", "sample_size_unit", "breakdowns", "severity", "description", "impact", "affected_views", "affected_views_per_hour", "affected_views_per_hour_on_open", "threshold", "notifications", "notification_rules", "error_description", "status" ] }, "IncidentNotification": { "type": "object", "properties": { "queued_at": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "attempted_at": { "type": "string" } }, "required": [ "queued_at", "id", "attempted_at" ] }, "IncidentNotificationRule": { "type": "object", "properties": { "status": { "type": "string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationRule" } }, "property_id": { "type": "string" }, "id": { "type": "string" }, "action": { "type": "string" } }, "required": [ "status", "rules", "property_id", "id", "action" ] }, "NotificationRule": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "value", "name", "id" ] }, "IncidentBreakdown": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id", "name", "value" ] }, "IncidentResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Incident" }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "ListRelatedIncidentsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } }, "total_row_count": { "type": "integer", "format": "int64", "nullable": true }, "timeframe": { "type": "array", "items": { "type": "integer", "format": "int64" } } }, "required": [ "data", "timeframe", "total_row_count" ] }, "ListAnnotationsResponse": { "type": "object", "required": [ "data", "total_row_count" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" } }, "total_row_count": { "type": "integer", "description": "Total number of annotations available" }, "timeframe": { "type": "array", "items": { "type": "integer" }, "minItems": 2, "maxItems": 2, "description": "Start and end unix timestamps for the data range" } } }, "Annotation": { "type": "object", "required": [ "id", "note", "date" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for the annotation" }, "note": { "type": "string", "description": "The annotation note content" }, "date": { "type": "string", "format": "date-time", "description": "Datetime when the annotation applies" }, "sub_property_id": { "type": "string", "nullable": true, "description": "Customer-defined sub-property identifier" } } }, "AnnotationInput": { "type": "object", "required": [ "note", "date" ], "properties": { "note": { "type": "string", "description": "The annotation note content" }, "date": { "type": "integer", "format": "int64", "description": "Datetime when the annotation applies (Unix timestamp)" }, "sub_property_id": { "type": "string", "description": "Customer-defined sub-property identifier" } } }, "AnnotationResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Annotation" } } } } } }```