Data API reference

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

List Video Views
get

Returns a list of video views

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

viewer_id

string

Viewer ID to filter results by. This value may be provided by the integration, or may be created by Mux.

error_id

integer

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.

order_direction

string

Possible values: "asc" "desc"

Sort order.

filters[]

array

Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US).
Possible filter names are the same as returned by the List Filters endpoint.

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/video-views

Response

(application/json)

{
  "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": null,
      "country_code": "US"
    },
    {
      "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": null,
      "country_code": "US"
    },
    {
      "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": null,
      "player_error_code": null,
      "id": "pdLDVKBuPZJJ9YsPVmtmB9FG9gsWBWMmYar4",
      "error_type_id": null,
      "country_code": "US"
    },
    {
      "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": null,
      "country_code": "US"
    }
  ]
}

Get a Video View
get

Returns the details of a video view

Request path & query params

VIDEO_VIEW_ID

string

ID of the Video View

get

200

/data/v1/video-views/{VIDEO_VIEW_ID}

Errors

A list of playback errors detected by Mux Data.

Properties

id.

integer

A unique identifier for this error.

percentage.

number

The percentage of views that experienced this error.

notes.

string

Notes that are attached to this error.

message.

string

The error message.

last_seen.

string

The last time this error was seen (ISO 8601 timestamp).

description.

string

Description of the error.

count.

integer

The total number of views that experiend this error.

code.

integer

The error code

List Errors
get

Returns a list of errors

Request path & query params

filters[]

array

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/errors

Response

(application/json)

{
  "total_row_count": null,
  "timeframe": [
    1610027061,
    1610113461
  ],
  "data": [
    {
      "percentage": null,
      "notes": null,
      "message": null,
      "last_seen": "2021-01-08T13:42:39Z",
      "id": null,
      "description": null,
      "count": 1,
      "code": 100
    }
  ]
}

Filters

List Filters
get

DEPRECATED

Deprecated: The API has been replaced by the list-dimensions API call.

Lists all the filters broken out into basic and advanced.

get

200

/data/v1/filters

Response

(application/json)

{
  "total_row_count": null,
  "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"
    ],
    "advanced": [
      "browser_version",
      "operating_system_version",
      "viewer_device_name",
      "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",
      "preroll_ad_asset_hostname",
      "preroll_ad_tag_hostname",
      "preroll_played",
      "preroll_requested"
    ]
  }
}

Lists values for a specific filter
get

DEPRECATED

Deprecated: The API has been replaced by the list-dimension-values API call.

Lists the values for a filter along with a total count of related views.

Request path & query params

FILTER_ID

string

ID of the Filter

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

filters[]

array

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/filters/{FILTER_ID}

Response

(application/json)

{
  "total_row_count": 1,
  "timeframe": [
    1610028123,
    1610114523
  ],
  "data": [
    {
      "value": "Chrome",
      "total_count": 5
    }
  ]
}

Exports

List property video view export links
get

Lists the available video view exports along with URLs to retrieve them

get

200

/data/v1/exports

Response

(application/json)

{
  "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..."
  ]
}

Metrics

List breakdown values
get

List the breakdown values for a specific metric

Request path & query params

METRIC_ID

string

Possible values: "aggregate_startup_time" "downscale_percentage" "exits_before_video_start" "max_downscale_percentage" "max_upscale_percentage" "page_load_time" "playback_failure_percentage" "playback_failure_score" "player_startup_time" "rebuffer_count" "rebuffer_duration" "rebuffer_frequency" "rebuffer_percentage" "rebuffer_score" "requests_for_first_preroll" "seek_latency" "startup_time_score" "upscale_percentage" "video_quality_score" "video_startup_preroll_load_time" "video_startup_preroll_request_time" "video_startup_time" "viewer_experience_score"

ID of the Metric

group_by

string

Possible values: "asn" "browser" "browser_version" "cdn" "country" "experiment_name" "operating_system" "operating_system_version" "player_name" "player_software" "player_software_version" "player_version" "preroll_ad_asset_hostname" "preroll_ad_tag_hostname" "preroll_played" "preroll_requested" "source_hostname" "source_type" "stream_type" "sub_property_id" "video_series" "video_title"

Breakdown value to group the results by

measurement

string

Possible values: "95th" "median" "avg"

Measurement for the provided metric. If omitted, the deafult for the metric will be used.

filters[]

array

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

order_by

string

Possible values: "negative_impact" "value" "views" "field"

Value to order the results by

order_direction

string

Possible values: "asc" "desc"

Sort order.

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/metrics/{METRIC_ID}/breakdown

Response

(application/json)

{
  "total_row_count": 1,
  "timeframe": [
    1610028298,
    1610114698
  ],
  "data": [
    {
      "views": 5,
      "value": 4,
      "total_watch_time": 513934,
      "negative_impact": 1,
      "field": "US"
    }
  ]
}

Get Overall values
get

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.

Request path & query params

METRIC_ID

string

ID of the Metric

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

filters[]

array

measurement

string

Possible values: "95th" "median" "avg"

Measurement for the provided metric. If omitted, the deafult for the metric will be used.

get

200

/data/v1/metrics/{METRIC_ID}/overall

Response

(application/json)

{
  "total_row_count": null,
  "timeframe": [
    1610029525,
    1610115925
  ],
  "data": {
    "value": 4,
    "total_watch_time": 513934,
    "total_views": 5,
    "global_value": 1169.1832095168065
  }
}

List Insights
get

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.

Request path & query params

METRIC_ID

string

ID of the Metric

measurement

string

Possible values: "95th" "median" "avg"

Measurement for the provided metric. If omitted, the deafult for the metric will be used.

order_direction

string

Possible values: "asc" "desc"

Sort order.

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/metrics/{METRIC_ID}/insights

Response

(application/json)

{
  "total_row_count": 18,
  "timeframe": [
    1610029610,
    1610116010
  ],
  "data": [
    {
      "total_watch_time": 351144,
      "total_views": 1,
      "negative_impact_score": -5,
      "metric": 9,
      "filter_value": "",
      "filter_column": "video_title"
    },
    {
      "total_watch_time": 513934,
      "total_views": 5,
      "negative_impact_score": 0,
      "metric": 4,
      "filter_value": "US",
      "filter_column": "country"
    }
  ]
}

Get metric timeseries data
get

Returns timeseries data for a specific metric

Request path & query params

METRIC_ID

string

ID of the Metric

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

filters[]

array

measurement

string

Possible values: "95th" "median" "avg"

Measurement for the provided metric. If omitted, the deafult for the metric will be used.

order_direction

string

Possible values: "asc" "desc"

Sort order.

group_by

string

Possible values: "hour" "day"

Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe.

get

200

/data/v1/metrics/{METRIC_ID}/timeseries

Response

(application/json)

{
  "total_row_count": 2,
  "timeframe": [
    1610029711,
    1610116111
  ],
  "data": [
    [
      "2021-01-07T14:00:00Z",
      null,
      null
    ],
    [
      "2021-01-07T15:00:00Z",
      null,
      null
    ]
  ]
}

List all metric values
get

List all of the values across every breakdown for a specific metric

Request path & query params

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

filters[]

array

dimension

string

Dimension the specified value belongs to

value

string

Value to show all available metrics for

get

200

/data/v1/metrics/comparison

Response

(application/json)

{
  "total_row_count": null,
  "timeframe": [
    1610029906,
    1610116306
  ],
  "data": [
    {
      "watch_time": 513934,
      "view_count": 5,
      "name": "totals"
    },
    {
      "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.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": 0,
          "type": "percentage",
          "name": "Exits Before Video Start",
          "metric": "exits_before_video_start"
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ]
}

Real-Time

List Real-Time Dimensions
get

Lists availiable real-time dimensions

get

200

/data/v1/realtime/dimensions

Response

(application/json)

{
  "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": null
}

List Real-Time Metrics
get

Lists availiable real-time metrics.

get

200

/data/v1/realtime/metrics

Response

(application/json)

{
  "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": null
}

Get Real-Time Breakdown
get

Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.

Request path & query params

REALTIME_METRIC_ID

string

Possible values: "current-concurrent-viewers" "current-rebuffering-percentage" "exits-before-video-start" "playback-failure-percentage" "current-average-bitrate"

ID of the Realtime Metric

dimension

string

Possible values: "asn" "cdn" "country" "operating_system" "player_name" "region" "stream_type" "sub_property_id" "video_series" "video_title"

Dimension the specified value belongs to

timestamp

number

Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.

filters[]

array

order_by

string

Possible values: "negative_impact" "value" "views" "field"

Value to order the results by

order_direction

string

Possible values: "asc" "desc"

Sort order.

get

200

/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/breakdown

Response

(application/json)

{
  "data": [
    {
      "concurrent_viewers": 2680,
      "metric_value": 0.008195679660675846,
      "negative_impact": 1,
      "value": "FR"
    },
    {
      "concurrent_viewers": 36,
      "metric_value": 0.010317417106767573,
      "negative_impact": 4,
      "value": "ES"
    },
    {
      "concurrent_viewers": 30,
      "metric_value": 0.06408818534303201,
      "negative_impact": 2,
      "value": "RE"
    },
    {
      "concurrent_viewers": 26,
      "metric_value": 0.008232510579858339,
      "negative_impact": 7,
      "value": "GB"
    },
    {
      "concurrent_viewers": 10,
      "metric_value": 0,
      "negative_impact": 26,
      "value": "BE"
    }
  ],
  "timeframe": [
    1610121421,
    1610121421
  ],
  "total_row_count": null
}

Get Real-Time Histogram Timeseries
get

Gets histogram timeseries information for a specific metric.

Request path & query params

REALTIME_METRIC_ID

string

Possible values: "current-concurrent-viewers" "current-rebuffering-percentage" "exits-before-video-start" "playback-failure-percentage" "current-average-bitrate"

ID of the Realtime Metric

filters[]

array

get

200

/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries

Response

(application/json)

{
  "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": null,
        "start": 10000
      }
    ]
  },
  "timeframe": [
    1610119800,
    1610121540
  ],
  "total_row_count": null
}

Get Real-Time Timeseries
get

Gets Time series information for a specific metric along with the number of concurrent viewers.

Request path & query params

REALTIME_METRIC_ID

string

Possible values: "current-concurrent-viewers" "current-rebuffering-percentage" "exits-before-video-start" "playback-failure-percentage" "current-average-bitrate"

ID of the Realtime Metric

filters[]

array

get

200

/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries

Response

(application/json)

{
  "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": null
}

Dimensions

List Dimensions
get

List all available dimensions.

Note: This API replaces the list-filters API call.

get

200

/data/v1/dimensions

Response

(application/json)

{
  "data": {
    "advanced": [
      "browser_version",
      "operating_system_version",
      "viewer_device_name",
      "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",
      "preroll_ad_asset_hostname",
      "preroll_ad_tag_hostname",
      "preroll_played",
      "preroll_requested"
    ],
    "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"
    ]
  },
  "timeframe": [
    1610033879,
    1610120279
  ],
  "total_row_count": null
}

Lists the values for a specific dimension
get

Lists the values for a dimension along with a total count of related views.

Note: This API replaces the list-filter-values API call.

Request path & query params

DIMENSION_ID

string

ID of the Dimension

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

filters[]

array

timeframe[]

array

Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are...

array of epoch timestamps e.g. timeframe[]=1498867200&timeframe[]=1498953600
duration string e.g. timeframe[]=24:hours or timeframe[]=7:days.

get

200

/data/v1/dimensions/{DIMENSION_ID}

Response

(application/json)

{
  "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
}

Incidents

List Incidents
get

Returns a list of incidents

Request path & query params

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

order_by

string

Possible values: "negative_impact" "value" "views" "field"

Value to order the results by

order_direction

string

Possible values: "asc" "desc"

Sort order.

status

string

Possible values: "open" "closed" "expired"

Status to filter incidents by

severity

string

Possible values: "warning" "alert"

Severity to filter incidents by

get

200

/data/v1/incidents

Response

(application/json)

{
  "data": [
    {
      "affected_views": 71,
      "affected_views_per_hour": 29,
      "affected_views_per_hour_on_open": 75,
      "breakdowns": [
        {
          "id": null,
          "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": null,
          "name": "video_title",
          "value": "Layla the dog video 1337"
        },
        {
          "id": null,
          "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
}

Get an Incident
get

Returns the details of an incident

Request path & query params

INCIDENT_ID

string

ID of the Incident

get

200

/data/v1/incidents/{INCIDENT_ID}

Response

(application/json)

{
  "data": {
    "affected_views": 2026,
    "affected_views_per_hour": 84,
    "affected_views_per_hour_on_open": 12857,
    "breakdowns": [
      {
        "id": null,
        "name": "error_type_id",
        "value": "499680"
      },
      {
        "id": null,
        "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": null
}

List Related Incidents
get

Returns all the incidents that seem related to a specific incident

Request path & query params

INCIDENT_ID

string

ID of the Incident

limit

integer

(default: 25)

Number of items to include in the response

page

integer

(default: 1)

Offset by this many pages, of the size of limit

order_by

string

Possible values: "negative_impact" "value" "views" "field"

Value to order the results by

order_direction

string

Possible values: "asc" "desc"

Sort order.

get

200

/data/v1/incidents/{INCIDENT_ID}/related

Response

(application/json)

{
  "data": [
    {
      "affected_views": 71,
      "affected_views_per_hour": 29,
      "affected_views_per_hour_on_open": 75,
      "breakdowns": [
        {
          "id": null,
          "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": null,
          "name": "video_title",
          "value": "Layla the dog video 1337"
        },
        {
          "id": null,
          "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
}

Docs

Docs

Request path & query params

Request path & query params

Properties

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params

Request path & query params