v23

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0127977.1 KB
Stats

Get user heartbeat spans

Returns heartbeat spans for a user, useful for visualizations. Accessible anonymously when the target user has public stats lookup enabled; otherwise the requester must be the user (authenticated via the User API Key).

get/api/v1/users/{username}/heartbeats/spans

Path parameters

usernamestring required

Username, Slack ID, or User ID. The literal value "my" resolves the user from the Authorization Bearer token.

Query parameters

start_datestring date_time

Start date/time (ISO 8601), defaults to 10 years ago

end_datestring date_time

End date/time (ISO 8601), defaults to end of today

projectstring

Filter by single project

filter_by_projectstring

Filter by multiple projects (comma separated). Ignored if project is present.

Response

successful

Example response

{
  "spans": [
    {
      "start_time": 1717689600,
      "end_time": 1717691820.5,
      "duration": 2220.5
    }
  ]
}