Skip to main content

Get user pulses

GET 

https://whatpulse.test/api/v1/users/:id/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.

Request

Path Parameters

    id stringrequired

    User ID or username

Query Parameters

    computer_id integer
    date_from date
    date_to date
    per_page integer

    Possible values: >= 1 and <= 100

Responses

Schema
    pulses object[]required
  • Array [
  • idintegerrequired

    The unique identifier for the pulse.

    datestringrequired

    The date and time when the pulse was recorded in ISO 8601 format.

    keysintegerrequired

    The number of keys pressed in this pulse.

    clicksintegerrequired

    The number of mouse clicks in this pulse.

    download_mbnumberrequired

    The amount of data downloaded in this pulse, in megabytes.

    upload_mbnumberrequired

    The amount of data uploaded in this pulse, in megabytes.

    uptime_secondsintegerrequired

    The uptime recorded in this pulse, in seconds.

    scrollsinteger | nullnullablerequired

    The number of mouse scrolls recorded in this pulse.

    distance_milesnumberrequired

    The distance the mouse has moved in miles in this pulse.

    auto_pulsebooleanrequired

    Whether this pulse was automatically generated by the app.

    client_versionstringrequired

    The version of the WhatPulse client that recorded this pulse.

  • ]
  • pagination objectrequired
    current_pageintegerrequired

    The current page number in the paginated result.

    per_pageintegerrequired

    The number of items per page in the paginated result.

    totalintegerrequired

    The total number of items across all pages.

    last_pageintegerrequired

    The total number of pages available in the paginated result.

    fromintegerrequired

    The starting item index for the current page.

    tointegerrequired

    The ending item index for the current page.

    links objectrequired
    firststringrequired

    The URL for the first page of results.

    laststringrequired

    The URL for the last page of results.

    prevstring | nullnullablerequired

    The URL for the previous page of results, or null if there is no previous page.

    nextstring | nullnullablerequired

    The URL for the next page of results, or null if there is no next page. If you're paginating, you can call this url to get the next page of results.

    filters objectrequired
    computer_idinteger | nullnullablerequired
    date_fromstring | nullnullablerequired
    date_tostring | nullnullablerequired

Authorization: http

name: httptype: httpscheme: bearer
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://whatpulse.test/api/v1/users/:id/pulses"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <token>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://whatpulse.test/api/v1
Auth
Parameters
— pathrequired
— query
— query
— query
— query
ResponseClear

Click the Send API Request button above and see the response here!