Skip to content

Support Incidents, Real Time, and Dimensions #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/DimensionValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# DimensionValue

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | | [optional]
**total_count** | **int** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


122 changes: 122 additions & 0 deletions docs/DimensionsApi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
# mux_python.DimensionsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_dimension_values**](DimensionsApi.md#list_dimension_values) | **GET** /data/v1/dimensions/{DIMENSION_ID} | Lists the values for a specific dimension
[**list_dimensions**](DimensionsApi.md#list_dimensions) | **GET** /data/v1/dimensions | List Dimensions


# **list_dimension_values**
> ListDimensionValuesResponse list_dimension_values(dimension_id, limit=limit, page=page, filters=filters, timeframe=timeframe)

Lists the values for a specific dimension

Lists the values for a dimension along with a total count of related views. Note: This API replaces the list-filter-values API call.

### Example

* Basic Authentication (accessToken):
```python
from __future__ import print_function
import time
import mux_python
from mux_python.rest import ApiException
from pprint import pprint
configuration = mux_python.Configuration()
# Configure HTTP basic authorization: accessToken
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = mux_python.DimensionsApi(mux_python.ApiClient(configuration))
dimension_id = abcd1234 # str | ID of the Dimension
limit = 25 # int | Number of items to include in the response (optional) (default to 25)
page = 1 # int | Offset by this many pages, of the size of `limit` (optional) (default to 1)
filters = ['filters_example'] # list[str] | 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. (optional)
timeframe = ['timeframe_example'] # list[str] | 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. (optional)

try:
# Lists the values for a specific dimension
api_response = api_instance.list_dimension_values(dimension_id, limit=limit, page=page, filters=filters, timeframe=timeframe)
pprint(api_response)
except ApiException as e:
print("Exception when calling DimensionsApi->list_dimension_values: %s\n" % e)
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**dimension_id** | **str**| ID of the Dimension |
**limit** | **int**| Number of items to include in the response | [optional] [default to 25]
**page** | **int**| Offset by this many pages, of the size of `limit` | [optional] [default to 1]
**filters** | [**list[str]**](str.md)| 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. | [optional]
**timeframe** | [**list[str]**](str.md)| 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. | [optional]

### Return type

[**ListDimensionValuesResponse**](ListDimensionValuesResponse.md)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **list_dimensions**
> ListDimensionsResponse list_dimensions()

List Dimensions

List all available dimensions. Note: This API replaces the list-filters API call.

### Example

* Basic Authentication (accessToken):
```python
from __future__ import print_function
import time
import mux_python
from mux_python.rest import ApiException
from pprint import pprint
configuration = mux_python.Configuration()
# Configure HTTP basic authorization: accessToken
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = mux_python.DimensionsApi(mux_python.ApiClient(configuration))

try:
# List Dimensions
api_response = api_instance.list_dimensions()
pprint(api_response)
except ApiException as e:
print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e)
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**ListDimensionsResponse**](ListDimensionsResponse.md)

### Authorization

[accessToken](../README.md#accessToken)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

4 changes: 2 additions & 2 deletions docs/FiltersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Method | HTTP request | Description

Lists values for a specific filter

Lists the values for a filter along with a total count of related views
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.

### Example

Expand Down Expand Up @@ -75,7 +75,7 @@ Name | Type | Description | Notes

List Filters

Lists all the filters broken out into basic and advanced
Deprecated: The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.

### Example

Expand Down
12 changes: 12 additions & 0 deletions docs/GetRealTimeBreakdownResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GetRealTimeBreakdownResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**list[RealTimeBreakdownValue]**](RealTimeBreakdownValue.md) | | [optional]
**total_row_count** | **int** | | [optional]
**timeframe** | **list[int]** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 13 additions & 0 deletions docs/GetRealTimeHistogramTimeseriesResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# GetRealTimeHistogramTimeseriesResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**meta** | [**GetRealTimeHistogramTimeseriesResponseMeta**](GetRealTimeHistogramTimeseriesResponseMeta.md) | | [optional]
**data** | [**list[RealTimeHistogramTimeseriesDatapoint]**](RealTimeHistogramTimeseriesDatapoint.md) | | [optional]
**total_row_count** | **int** | | [optional]
**timeframe** | **list[int]** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


10 changes: 10 additions & 0 deletions docs/GetRealTimeHistogramTimeseriesResponseMeta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# GetRealTimeHistogramTimeseriesResponseMeta

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**buckets** | [**list[RealTimeHistogramTimeseriesBucket]**](RealTimeHistogramTimeseriesBucket.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/GetRealTimeTimeseriesResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# GetRealTimeTimeseriesResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**list[RealTimeTimeseriesDatapoint]**](RealTimeTimeseriesDatapoint.md) | | [optional]
**total_row_count** | **int** | | [optional]
**timeframe** | **list[int]** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/Incident.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Incident

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**threshold** | **float** | | [optional]
**status** | **str** | | [optional]
**started_at** | **str** | | [optional]
**severity** | **str** | | [optional]
**sample_size_unit** | **str** | | [optional]
**sample_size** | **int** | | [optional]
**resolved_at** | **str** | | [optional]
**notifications** | [**list[IncidentNotification]**](IncidentNotification.md) | | [optional]
**notification_rules** | [**list[IncidentNotificationRule]**](IncidentNotificationRule.md) | | [optional]
**measurement** | **str** | | [optional]
**measured_value_on_close** | **float** | | [optional]
**measured_value** | **float** | | [optional]
**incident_key** | **str** | | [optional]
**impact** | **str** | | [optional]
**id** | **str** | | [optional]
**error_description** | **str** | | [optional]
**description** | **str** | | [optional]
**breakdowns** | [**list[IncidentBreakdown]**](IncidentBreakdown.md) | | [optional]
**affected_views_per_hour_on_open** | **int** | | [optional]
**affected_views_per_hour** | **int** | | [optional]
**affected_views** | **int** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/IncidentBreakdown.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# IncidentBreakdown

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | | [optional]
**name** | **str** | | [optional]
**id** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


12 changes: 12 additions & 0 deletions docs/IncidentNotification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# IncidentNotification

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**queued_at** | **str** | | [optional]
**id** | **int** | | [optional]
**attempted_at** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


14 changes: 14 additions & 0 deletions docs/IncidentNotificationRule.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# IncidentNotificationRule

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | | [optional]
**rules** | [**list[NotificationRule]**](NotificationRule.md) | | [optional]
**property_id** | **str** | | [optional]
**id** | **str** | | [optional]
**action** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


11 changes: 11 additions & 0 deletions docs/IncidentResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# IncidentResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**Incident**](.md) | | [optional]
**timeframe** | **list[int]** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading