Get an activity summary | Wakapi unofficial

10 parameters

intervalstringoptional

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

fromstringoptional

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

tostringoptional

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

recomputebooleanoptional

Whether to recompute the summary from raw heartbeats instead of using the cache.

projectstringoptional

Filter the summary by project.

languagestringoptional

Filter the summary by language.

editorstringoptional

Filter the summary by editor.

operating_systemstringoptional

Filter the summary by operating system.

machinestringoptional

Filter the summary by machine.

labelstringoptional

Filter the summary by project label.

1 status code

200Returns an activity summary with totals grouped by categories such as languages, projects, editors, machines, and operating systems, along with the summary date range and user ID.

branchesarray<object>optional

branches are not persisted, but calculated at runtime in case a project Filter is applied

categoriesarray<object>optional

editorsarray<object>optional

entitiesarray<object>optional

entities are not persisted, but calculated at runtime in case a project Filter is applied

fromstringoptional

filled by gorm if not set, see https://gorm.io/docs/conventions.html#CreatedAt

labelsarray<object>optional

labels are not persisted, but calculated at runtime, i.e. when summary is retrieved

languagesarray<object>optional

machinesarray<object>optional

operating_systemsarray<object>optional

projectsarray<object>optional

Previously, all the following properties created a cascade foreign key constraint on the summary_items table back to this summary table resulting in 5 identical foreign key constraints on the summary_items table. This is not a problem for PostgreSQL, MySQL and SQLite, but for MSSQL (not supported anymore though), which complains about circular cascades on update/delete between these two tables. All of these created foreign key constraints are identical, so only one constraint is enough. MySQL will create a foreign key constraint for every property referencing other structs, even no constraint is specified in tags. So explicitly set gorm:"-" in all other properties to avoid creating duplicate foreign key constraints

tostringoptional

filled by gorm if not set, see https://gorm.io/docs/conventions.html#CreatedAt

user_idstringoptional

Error handling

If supplied, interval must be a supported value; 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. recompute must be a boolean when provided.

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.summary.list({
  interval: "example",
  from: "example",
  to: "example",
  recompute: "example",
  project: "example",
});

{
  "branches": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "categories": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "editors": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "entities": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "from": "2006-01-02 15:04:05.000",
  "labels": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "languages": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "machines": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "operating_systems": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "projects": [
    {
      "key": "example_key_abc123",
      "total": 42
    }
  ],
  "to": "2006-01-02 15:04:05.000",
  "user_id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors