Mux Data is a platform for monitoring your video streaming performance with just a few lines of code. Get in-depth quality of service analytics on web, mobile, and OTT devices.
The Datacoral Mux slice collects data from a Mux account and enables data flow of metrics, views, and video errors into a data warehouse, such as Redshift.
Steps to add this slice to your installation
The steps to launch your slice are:
- Generate Mux API keys
- Specify the slice config
- Add the Mux slice
1. Generate Mux API keys
Before getting started please make sure to have the following information:
- Access to an active Mux account
The Mux slice requires an access token id and access token secret to collect data. An access token id and access token secret can be obtained from Mux through the following steps:
- Log in to your Mux account
- Navigate to Settings → "API Access Tokens" → "Generate new token"
- Select the environment you wish to collect data from
- Choose "Read" under Mux Data permissions then "Generate Token"
- Your access token id and secret will display on the page. Copy both.
2. Specify the slice config
To get a template for the Mux Data slice configuration save the output of the
describe --input-parameters command as follows:
mux_parameters_file file to add the access token id and access token secret generated from Mux.
3. Add the Slice
slice-name: Name of your slice. A schema with your slice-name is automatically created in your warehouse
params-file: File path to your input parameters file. Ex. mux_parameters_file.json
Supported load units
metrics: this loadunit is used to store information about particular metrics
breakdown_groups; this loadunit does not store any data, it fans out next loadunit with the breakdown filters requested
- this loadunit only executes in a snapshot fashion
metric_breakdowns: this loadunit is used to store information about metrics accross particular breakdowns
metric_insights: this loadunit is used to store information about metric insights
metric_timeseries: this loadunit is used to store information about metrics accross particular timeseries
overall_metrics: this loadunit is used to store information about about particular metrics globally in Mux
video_errors: this loadunit is used to store information about particular video errors
video_views: this loadunit is used to store information about particular video viewings
filters: this loadunit is used to store available filters
- this loadunit only supports a snapshot fetch mode
filter_details: this loadunit is used to store information about views relating to particular filter values
Important API notes
Unless specified above, loadunits will only support incremental fetch mode. This is because metrics are calculated based off the video viewings that occur in a given timeframe.
The earliest date for which the slice can retrieve data changes depending on the date of the fetch. This is because each Mux account has a "data retention period", outside of which data is not stored by Mux. This data retention period is a number of days prior to the current date (either 7, 30 or 90).
Output of this slice is stored in S3 and the destination warehouse..
Data stored in AWS S3 is partitioned by date and time
Destination Warehouse: Schema - schema name will be same as slice-name. Tables produced by the slice are: