v7

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01426118.4 KB
Admin Utils

Get heartbeat values

Get specific values from heartbeats.

get/api/admin/v1/user/heartbeat_values

Query parameters

user_idstring

User ID. Either user_id or id may be supplied.

idstring

Alias for user_id. If both id and user_id are supplied, id takes precedence.

field'projects' | 'languages' | 'entities' | 'branches' | 'categories' | 'editors' | 'machines' | 'user_agents' | 'ips'

Field to retrieve distinct values for. Must be one of the allowed values; an unknown value returns 422.

start_datestring

Start date (YYYY-MM-DD or timestamp)

end_datestring

End date (YYYY-MM-DD or timestamp)

limitinteger

Limit results (default 5000, max 5000)

Response

successful

user_idinteger
fieldstring
valuesstring[]
countinteger

Example response

{
  "user_id": 42,
  "field": "projects",
  "values": [
    "hackatime"
  ],
  "count": 12
}