lib/datadog_api_client/v2/api/rum_api.rb
# Get a list of RUM events
# List endpoint returns events that match a RUM search query.
# [Results are paginated][1].
#
# Use this endpoint to see your latest RUM events.
#
# [1]: https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination
# @param opts [Hash] the optional parameters
# @option opts [String] :filter_query Search query following RUM syntax.
# @option opts [Time] :filter_from Minimum timestamp for requested events.
# @option opts [Time] :filter_to Maximum timestamp for requested events.
# @option opts [RUMSort] :sort Order of events in results.
# @option opts [String] :page_cursor List following results with a cursor provided in the previous query.
# @option opts [Integer] :page_limit Maximum number of events in the response.
# @return [Array<(RUMEventsResponse, Integer, Hash)>] RUMEventsResponse data, response status code and response headers
Get a list of RUM events
List endpoint returns events that match a RUM search query.
[Results are paginated][1].

Use this endpoint to see your latest RUM events.


Get a list of RUM events List endpoint returns events that match a RUM search query . [ Results are paginated ] [ 1 ] . Use this endpoint to see your latest RUM events .
def list_rum_events_with_http_info(opts = {})
      if @api_client.config.unstable_operations.has_key?(:list_rum_events)
        unstable_enabled = @api_client.config.unstable_operations[:list_rum_events]
        if unstable_enabled
          @api_client.config.logger.warn format("Using unstable operation '%s'", "list_rum_events")
        else
          raise APIError.new(message: format("Unstable operation '%s' is disabled", "list_rum_events"))
        end
      end
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: RUMAPI.list_rum_events ...'
      end
      allowable_values = ['timestamp', '-timestamp']
      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
      end
      if @api_client.config.client_side_validation && !opts[:'page_limit'].nil? && opts[:'page_limit'] > 1000
        fail ArgumentError, 'invalid value for "opts[:"page_limit"]" when calling RUMAPI.list_rum_events, must be smaller than or equal to 1000.'
      end
      local_var_path = '/api/v2/rum/events'
      query_params = opts[:query_params] || {}
      query_params[:'filter[query]'] = opts[:'filter_query'] if !opts[:'filter_query'].nil?
      query_params[:'filter[from]'] = opts[:'filter_from'] if !opts[:'filter_from'].nil?
      query_params[:'filter[to]'] = opts[:'filter_to'] if !opts[:'filter_to'].nil?
      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
      query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
      query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type] || 'RUMEventsResponse'
      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
      new_options = opts.merge(
        :operation => :list_rum_events,
        :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: RUMAPI#list_rum_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def list_rum_events_with_http_info ( opts = { } ) if @api_client . config . unstable_operations . has_key? ( :list_rum_events ) unstable_enabled = @api_client . config . unstable_operations [ :list_rum_events ] if unstable_enabled @api_client . config . logger . warn format ( "Using unstable operation '%s'" , "list_rum_events" ) else raise APIError . new ( message : format ( "Unstable operation '%s' is disabled" , "list_rum_events" ) ) end end if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: RUMAPI.list_rum_events ...' end allowable_values = [ 'timestamp' , '-timestamp' ] if @api_client . config . client_side_validation && opts [ :' sort ' ] && ! allowable_values . include? ( opts [ :' sort ' ] ) fail ArgumentError , "invalid value for \"sort\", must be one of #{allowable_values}" end if @api_client . config . client_side_validation && ! opts [ :' page_limit ' ] . nil? && opts [ :' page_limit ' ] > 1000 fail ArgumentError , 'invalid value for "opts[:"page_limit"]" when calling RUMAPI.list_rum_events, must be smaller than or equal to 1000.' end local_var_path = '/api/v2/rum/events' query_params = opts [ :query_params ] || { } query_params [ :' filter[query] ' ] = opts [ :' filter_query ' ] if ! opts [ :' filter_query ' ] . nil? query_params [ :' filter[from] ' ] = opts [ :' filter_from ' ] if ! opts [ :' filter_from ' ] . nil? query_params [ :' filter[to] ' ] = opts [ :' filter_to ' ] if ! opts [ :' filter_to ' ] . nil? query_params [ :' sort ' ] = opts [ :' sort ' ] if ! opts [ :' sort ' ] . nil? query_params [ :' page[cursor] ' ] = opts [ :' page_cursor ' ] if ! opts [ :' page_cursor ' ] . nil? query_params [ :' page[limit] ' ] = opts [ :' page_limit ' ] if ! opts [ :' page_limit ' ] . nil? header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] || 'RUMEventsResponse' auth_names = opts [ :debug_auth_names ] || [ :apiKeyAuth , :appKeyAuth , :AuthZ ] new_options = opts . merge ( :operation => :list_rum_events , :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: RUMAPI#list_rum_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Get a list of RUM events
List endpoint returns events that match a RUM search query.
Get a list of RUM events List endpoint returns events that match a RUM search query .
# resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
RUMEventsResponse data, response status code and response headers
RUMEventsResponse data response status code and response headers
Array<(RUMEventsResponse, Integer, Hash)>
opts
:page_limit Maximum number of events in the response.
: page_limit Maximum number of events in the response .