Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 2.41 KB

File metadata and controls

87 lines (63 loc) · 2.41 KB

WhatpulseSdk::PulsesApi

All URIs are relative to https://whatpulse.test/api/v1

Method HTTP request Description
v1_users_pulses GET /users/{id}/pulses Get user pulses

v1_users_pulses

v1_users_pulses(id, opts)

Get user pulses

Get a list of pulses for a specific user. Pulses represent individual data points collected by WhatPulse, such as key presses, mouse clicks, and network activity. You can filter by computer ID, date range, and control pagination. The response includes pulse information with associated computer details if you have the appropriate permissions.

Examples

require 'time'
require 'whatpulse-sdk'
# setup authorization
WhatpulseSdk.configure do |config|
  # Configure Bearer authorization: http
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = WhatpulseSdk::PulsesApi.new
id = 'id_example' # String | User ID or username
opts = {
  computer_id: 56, # Integer | 
  date_from: Date.parse('2013-10-20'), # Date | 
  date_to: Date.parse('2013-10-20'), # Date | 
  per_page: 56 # Integer | 
}

begin
  # Get user pulses
  result = api_instance.v1_users_pulses(id, opts)
  p result
rescue WhatpulseSdk::ApiError => e
  puts "Error when calling PulsesApi->v1_users_pulses: #{e}"
end

Using the v1_users_pulses_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_users_pulses_with_http_info(id, opts)

begin
  # Get user pulses
  data, status_code, headers = api_instance.v1_users_pulses_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <V1UsersPulses200Response>
rescue WhatpulseSdk::ApiError => e
  puts "Error when calling PulsesApi->v1_users_pulses_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String User ID or username
computer_id Integer [optional]
date_from Date [optional]
date_to Date [optional]
per_page Integer [optional]

Return type

V1UsersPulses200Response

Authorization

http

HTTP request headers

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