Get WakaTime-compatible summaries

10 parameters

userstringrequired

User ID to retrieve data for, or `current` for the current user.

rangestringoptional

Interval for the summary. Supported values include today, yesterday, week, month, year, 7_days, last_7_days, 30_days, last_30_days, 6_months, last_6_months, and 12_months.

Allowed:todayyesterdayweekmonthyear7_dayslast_7_days30_dayslast_30_days6_monthslast_6_months12_months

startstringoptional

Start date for the summary period, for example `2021-02-07`.

endstringoptional

End date for the summary period, for example `2021-02-08`.

projectstringoptional

Filter summaries by project.

languagestringoptional

Filter summaries by language.

editorstringoptional

Filter summaries by editor.

operating_systemstringoptional

Filter summaries by operating system.

machinestringoptional

Filter summaries by machine.

labelstringoptional

Filter summaries by project label.

1 status code

200Returns summary data including cumulative totals, daily averages, the requested date range, and summary breakdowns such as languages, projects, editors, and operating systems.

cumulative_totalobjectoptional

daily_averageobjectoptional

dataarray<object>optional

endstringoptional

startstringoptional

Error handling

Use user as a user ID or current. range must be a supported interval; the listed values include today, yesterday, week, month, year, 7_days, last_7_days, 30_days, last_30_days, 6_months, last_6_months, and 12_months.

import { Client } from "wakapi-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { apiKey: process.env.API_KEY },
});

const result = await client.summaries.list({
  user: "octocat",
  range: "example",
  start: 0,
  end: "example",
  project: "example",
});

{
  "cumulative_total": {
    "decimal": "example_value",
    "digital": "example_value",
    "seconds": 1,
    "text": "example_value"
  },
  "daily_average": {
    "days_including_holidays": 1,
    "days_minus_holidays": 1,
    "holidays": 1,
    "seconds": 1,
    "seconds_including_other_language": 1,
    "text": "example_value",
    "text_including_other_language": "example_value"
  },
  "data": [
    {
      "branches": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "categories": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "dependencies": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "editors": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "entities": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "grand_total": {
        "digital": "example_value",
        "hours": 1,
        "minutes": 1,
        "text": "example_value",
        "total_seconds": 42
      },
      "languages": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "machines": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "operating_systems": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "projects": [
        {
          "digital": "example_value",
          "hours": 1,
          "minutes": 1,
          "name": "Example Name",
          "percent": 1,
          "seconds": 1,
          "text": "example_value",
          "total_seconds": 42
        }
      ],
      "range": {
        "date": "2026-01-15T09:00:00Z",
        "end": "example_value",
        "start": "example_value",
        "text": "example_value",
        "timezone": "2026-01-15T09:00:00Z"
      }
    }
  ],
  "end": "example_value",
  "start": "example_value"
}

Request

Response

Errors