Mux.Csharp.Sdk.Api.MonitoringApi

All URIs are relative to https://api.mux.com

Method	HTTP request	Description
GetMonitoringBreakdown	GET /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown	Get Monitoring Breakdown
GetMonitoringBreakdownTimeseries	GET /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries	Get Monitoring Breakdown Timeseries
GetMonitoringHistogramTimeseries	GET /data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries	Get Monitoring Histogram Timeseries
GetMonitoringTimeseries	GET /data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries	Get Monitoring Timeseries
ListMonitoringDimensions	GET /data/v1/monitoring/dimensions	List Monitoring Dimensions
ListMonitoringMetrics	GET /data/v1/monitoring/metrics	List Monitoring Metrics

GetMonitoringBreakdown

GetMonitoringBreakdownResponse GetMonitoringBreakdown (string MONITORING_METRIC_ID, string dimension = null, int? timestamp = null, List filters = null, string orderBy = null, string orderDirection = null)

Get Monitoring Breakdown

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class GetMonitoringBreakdownExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);
            var MONITORING_METRIC_ID = current-concurrent-viewers;  // string | ID of the Monitoring Metric
            var dimension = "asn";  // string | Dimension the specified value belongs to (optional) 
            var timestamp = 56;  // int? | Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp. (optional) 
            var filters = new List<string>(); // List<string> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`  (optional) 
            var orderBy = "negative_impact";  // string | Value to order the results by (optional) 
            var orderDirection = "asc";  // string | Sort order. (optional) 

            try
            {
                // Get Monitoring Breakdown
                GetMonitoringBreakdownResponse result = apiInstance.GetMonitoringBreakdown(MONITORING_METRIC_ID, dimension, timestamp, filters, orderBy, orderDirection);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.GetMonitoringBreakdown: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
MONITORING_METRIC_ID	string	ID of the Monitoring Metric
dimension	string	Dimension the specified value belongs to	[optional]
timestamp	int?	Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.	[optional]
filters	List<string>	Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`	[optional]
orderBy	string	Value to order the results by	[optional]
orderDirection	string	Sort order.	[optional]

Return type

GetMonitoringBreakdownResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMonitoringBreakdownTimeseries

GetMonitoringBreakdownTimeseriesResponse GetMonitoringBreakdownTimeseries (string MONITORING_METRIC_ID, string dimension = null, List timeframe = null, List filters = null, int? limit = null, string orderBy = null, string orderDirection = null)

Get Monitoring Breakdown Timeseries

Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class GetMonitoringBreakdownTimeseriesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);
            var MONITORING_METRIC_ID = current-concurrent-viewers;  // string | ID of the Monitoring Metric
            var dimension = "asn";  // string | Dimension the specified value belongs to (optional) 
            var timeframe = new List<string>(); // List<string> | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  The 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.  (optional) 
            var filters = new List<string>(); // List<string> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`  (optional) 
            var limit = 10;  // int? | Number of items to include in each timestamp's `value` list.  The default is 10, and the maximum is 100.  (optional)  (default to 10)
            var orderBy = "negative_impact";  // string | Value to order the results by (optional) 
            var orderDirection = "asc";  // string | Sort order. (optional) 

            try
            {
                // Get Monitoring Breakdown Timeseries
                GetMonitoringBreakdownTimeseriesResponse result = apiInstance.GetMonitoringBreakdownTimeseries(MONITORING_METRIC_ID, dimension, timeframe, filters, limit, orderBy, orderDirection);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.GetMonitoringBreakdownTimeseries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
MONITORING_METRIC_ID	string	ID of the Monitoring Metric
dimension	string	Dimension the specified value belongs to	[optional]
timeframe	List<string>	Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). The 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.	[optional]
filters	List<string>	Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`	[optional]
limit	int?	Number of items to include in each timestamp's `value` list. The default is 10, and the maximum is 100.	[optional] [default to 10]
orderBy	string	Value to order the results by	[optional]
orderDirection	string	Sort order.	[optional]

Return type

GetMonitoringBreakdownTimeseriesResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMonitoringHistogramTimeseries

GetMonitoringHistogramTimeseriesResponse GetMonitoringHistogramTimeseries (string MONITORING_HISTOGRAM_METRIC_ID, List filters = null)

Get Monitoring Histogram Timeseries

Gets histogram timeseries information for a specific metric.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class GetMonitoringHistogramTimeseriesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);
            var MONITORING_HISTOGRAM_METRIC_ID = video-startup-time;  // string | ID of the Monitoring Histogram Metric
            var filters = new List<string>(); // List<string> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`  (optional) 

            try
            {
                // Get Monitoring Histogram Timeseries
                GetMonitoringHistogramTimeseriesResponse result = apiInstance.GetMonitoringHistogramTimeseries(MONITORING_HISTOGRAM_METRIC_ID, filters);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.GetMonitoringHistogramTimeseries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
MONITORING_HISTOGRAM_METRIC_ID	string	ID of the Monitoring Histogram Metric
filters	List<string>	Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`	[optional]

Return type

GetMonitoringHistogramTimeseriesResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMonitoringTimeseries

GetMonitoringTimeseriesResponse GetMonitoringTimeseries (string MONITORING_METRIC_ID, List filters = null, int? timestamp = null)

Get Monitoring Timeseries

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

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class GetMonitoringTimeseriesExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);
            var MONITORING_METRIC_ID = current-concurrent-viewers;  // string | ID of the Monitoring Metric
            var filters = new List<string>(); // List<string> | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`  (optional) 
            var timestamp = 56;  // int? | Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago. (optional) 

            try
            {
                // Get Monitoring Timeseries
                GetMonitoringTimeseriesResponse result = apiInstance.GetMonitoringTimeseries(MONITORING_METRIC_ID, filters, timestamp);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.GetMonitoringTimeseries: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
MONITORING_METRIC_ID	string	ID of the Monitoring Metric
filters	List<string>	Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`	[optional]
timestamp	int?	Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.	[optional]

Return type

GetMonitoringTimeseriesResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListMonitoringDimensions

ListMonitoringDimensionsResponse ListMonitoringDimensions ()

List Monitoring Dimensions

Lists available monitoring dimensions.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class ListMonitoringDimensionsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);

            try
            {
                // List Monitoring Dimensions
                ListMonitoringDimensionsResponse result = apiInstance.ListMonitoringDimensions();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.ListMonitoringDimensions: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListMonitoringDimensionsResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListMonitoringMetrics

ListMonitoringMetricsResponse ListMonitoringMetrics ()

List Monitoring Metrics

Lists available monitoring metrics.

Example

using System.Collections.Generic;
using System.Diagnostics;
using Mux.Csharp.Sdk.Api;
using Mux.Csharp.Sdk.Client;
using Mux.Csharp.Sdk.Model;

namespace Example
{
    public class ListMonitoringMetricsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mux.com";
            // Configure HTTP basic authorization: accessToken
            config.Username = "YOUR_USERNAME";
            config.Password = "YOUR_PASSWORD";

            var apiInstance = new MonitoringApi(config);

            try
            {
                // List Monitoring Metrics
                ListMonitoringMetricsResponse result = apiInstance.ListMonitoringMetrics();
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling MonitoringApi.ListMonitoringMetrics: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

ListMonitoringMetricsResponse

Authorization

accessToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

MonitoringApi.md

Latest commit

History

MonitoringApi.md

File metadata and controls

Mux.Csharp.Sdk.Api.MonitoringApi

GetMonitoringBreakdown

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMonitoringBreakdownTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMonitoringHistogramTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GetMonitoringTimeseries

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListMonitoringDimensions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

ListMonitoringMetrics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details