v23

OpenAPI 3.0.1raw.githubusercontent.com2026-08-0127977.1 KB

WakaTime Compatibility

Get WakaTime-compatible summary

Returns a summary of coding activity in a format compatible with WakaTime clients. This endpoint does NOT authenticate any API token: access is gated solely by the target user (identified by user_id/user) having allow_public_stats_lookup enabled. No caller credentials are required or verified.

get/api/summary

Query parameters

startstring date

Start date (YYYY-MM-DD). Requires "end"/"to" to be set as well to form an explicit range.

fromstring date

Alias for "start". Used when "start" is absent.

endstring date

End date (YYYY-MM-DD). Requires "start"/"from" to be set as well to form an explicit range.

tostring date

Alias for "end". Used when "end" is absent.

intervalstring

Interval keyword. One of: today, yesterday, week, 7_days, last_7_days, month, 30_days, last_30_days, 6_months, last_6_months, year, 12_months, last_12_months, last_year, any, all_time. Defaults to all_time when neither interval nor range is given; unknown values fall back to today.

rangestring

Fallback interval keyword used when "interval" is absent. Accepts the same values as "interval".

user_idstring required

User identifier (slack_uid, username, hca_id, or numeric ID)

userstring

Deprecated: use user_id instead. Kept for backwards compatibility.

Response

successful

user_idstring nullable

fromstring date_time

tostring date_time

editorsobject nullable

operating_systemsobject nullable

machinesobject nullable

categoriesobject nullable

branchesobject nullable

entitiesobject nullable

labelsobject nullable

Example response

{
  "user_id": "U0266FRGP",
  "from": "2023-01-01T00:00:00Z",
  "to": "2023-01-31T23:59:59Z",
  "projects": [
    {
      "key": "hackatime",
      "total": 21600
    }
  ],
  "languages": [
    {
      "key": "Ruby",
      "total": 18000
    }
  ]
}