---
title: "Get WakaTime-compatible summary"
method: GET
path: "/api/summary"
tags: ["WakaTime Compatibility"]
---

# Get WakaTime-compatible summary

`GET /api/summary`

Returns a summary of coding activity in a format compatible with WakaTime clients. This endpoint supports querying by date range, interval, or specific user (admin/privileged only).

## Query parameters

- `start` string, date
- `end` string, date
- `interval` string
- `project` string
- `user_id` string, required
- `user` string

## Response `200`

successful

- object
  - `user_id` string, nullable
  - `from` string, date_time
  - `to` string, date_time
  - `projects` object[]
    - `key` string
    - `total` number
  - `languages` object[]
    - `key` string
    - `total` number
  - `editors` object, nullable
  - `operating_systems` object, nullable
  - `machines` object, nullable
  - `categories` object, nullable
  - `branches` object, nullable
  - `entities` object, nullable
  - `labels` object, nullable

## Other responses

- `400` — invalid date range
- `403` — user has disabled public stats
- `404` — user not found

## Changes

- **2026-04-12** (v1) `347f8d8305fa` — 1 breaking, 2 info
  - added the new required `query` request parameter `user_id`
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
- **2026-01-28** (v1) `a9eaba48a93a` — 2 breaking
  - for the `query` request parameter `end`, the type/format was changed from `string`/`` to `string`/`date`
  - for the `query` request parameter `start`, the type/format was changed from `string`/`` to `string`/`date`
- **2026-01-27** (v1) `b6d6849481da` — 4 warning, 6 info
  - deleted the `query` request parameter `from`
  - deleted the `query` request parameter `range`
  - deleted the `query` request parameter `to`
  - deleted the `query` request parameter `user_id`
  - …6 more

[Change history](https://skmtc.dev/hackclub/apis/hackatime-api/changes/api/summary/get.md)

---

[API](https://skmtc.dev/hackclub/apis/hackatime-api.md) · [All operations](https://skmtc.dev/hackclub/apis/hackatime-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hackclub/hackatime-api/revisions/78326ea7a9a9/schema)