Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.37 KB

ErrorsApi.md

File metadata and controls

64 lines (44 loc) · 2.37 KB

MuxRuby::ErrorsApi

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

Method HTTP request Description
list_errors GET /data/v1/errors List Errors

list_errors

ListErrorsResponse list_errors(opts)

List Errors

Returns a list of errors

Example

# load the gem
require 'mux_ruby'
# setup authorization
MuxRuby.configure do |config|
  # Configure HTTP basic authorization: accessToken
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = MuxRuby::ErrorsApi.new
opts = {
  filters: ['filters_example'], # Array<String> | 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: ['timeframe_example'] # Array<String> | 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. 
}

begin
  #List Errors
  result = api_instance.list_errors(opts)
  p result
rescue MuxRuby::ApiError => e
  puts "Exception when calling ErrorsApi->list_errors: #{e}"
end

Parameters

Name Type Description Notes
filters Array<String> 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 Array<String> 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

ListErrorsResponse

Authorization

accessToken

HTTP request headers

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