class MuxRuby::DimensionsApi
Attributes
Public Class Methods
# File lib/mux_ruby/api/dimensions_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param dimension_id [String] ID of the Dimension @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of items to include in the response (default to 25) @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1) @option opts [Array<String>] :filters 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. @option opts [Array<String>] :timeframe 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. @return [ListDimensionValuesResponse]
# File lib/mux_ruby/api/dimensions_api.rb, line 31 def list_dimension_values(dimension_id, opts = {}) data, _status_code, _headers = list_dimension_values_with_http_info(dimension_id, opts) data end
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. @param dimension_id [String] ID of the Dimension @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of items to include in the response @option opts [Integer] :page Offset by this many pages, of the size of `limit` @option opts [Array<String>] :filters 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. @option opts [Array<String>] :timeframe 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. @return [Array<(ListDimensionValuesResponse
, Integer, Hash)>] ListDimensionValuesResponse
data, response status code and response headers
# File lib/mux_ruby/api/dimensions_api.rb, line 45 def list_dimension_values_with_http_info(dimension_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DimensionsApi.list_dimension_values ...' end # verify the required parameter 'dimension_id' is set if @api_client.config.client_side_validation && dimension_id.nil? fail ArgumentError, "Missing the required parameter 'dimension_id' when calling DimensionsApi.list_dimension_values" end # resource path local_var_path = '/data/v1/dimensions/{DIMENSION_ID}'.sub('{' + 'DIMENSION_ID' + '}', CGI.escape(dimension_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil? query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListDimensionValuesResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"DimensionsApi.list_dimension_values", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DimensionsApi#list_dimension_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Dimensions List all available dimensions. Note: This API replaces the list-filters API call. @param [Hash] opts the optional parameters @return [ListDimensionsResponse]
# File lib/mux_ruby/api/dimensions_api.rb, line 101 def list_dimensions(opts = {}) data, _status_code, _headers = list_dimensions_with_http_info(opts) data end
List Dimensions List all available dimensions. Note: This API replaces the list-filters API call. @param [Hash] opts the optional parameters @return [Array<(ListDimensionsResponse
, Integer, Hash)>] ListDimensionsResponse
data, response status code and response headers
# File lib/mux_ruby/api/dimensions_api.rb, line 110 def list_dimensions_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DimensionsApi.list_dimensions ...' end # resource path local_var_path = '/data/v1/dimensions' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'ListDimensionsResponse' # auth_names auth_names = opts[:debug_auth_names] || ['accessToken'] new_options = opts.merge( :operation => :"DimensionsApi.list_dimensions", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: DimensionsApi#list_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end