{"id":13602518,"url":"https://github.com/jaebradley/wakatime-client","last_synced_at":"2025-10-07T06:38:14.662Z","repository":{"id":31113826,"uuid":"126857992","full_name":"jaebradley/wakatime-client","owner":"jaebradley","description":"🖥 JavaScript Client for https://wakatime.com/developers","archived":false,"fork":false,"pushed_at":"2023-01-04T01:15:30.000Z","size":3479,"stargazers_count":43,"open_issues_count":14,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-21T22:38:13.674Z","etag":null,"topics":["javascript","nodejs","npm","npm-package","waka","wakatime","wakatime-api"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/wakatime-client","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jaebradley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-26T16:31:28.000Z","updated_at":"2025-04-15T02:07:03.000Z","dependencies_parsed_at":"2023-01-14T18:21:54.233Z","dependency_job_id":null,"html_url":"https://github.com/jaebradley/wakatime-client","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/jaebradley/wakatime-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fwakatime-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fwakatime-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fwakatime-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fwakatime-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jaebradley","download_url":"https://codeload.github.com/jaebradley/wakatime-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jaebradley%2Fwakatime-client/sbom","scorecard":{"id":501870,"data":{"date":"2025-08-11","repo":{"name":"github.com/jaebradley/wakatime-client","commit":"a859dfc999ecc154ad9987d23b8cd17cbfaf21c0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Code-Review","score":1,"reason":"Found 2/19 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/workflows.yaml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/workflows.yaml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/workflows.yaml:76: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/workflows.yaml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/jaebradley/wakatime-client/workflows.yaml/master?enable=pin","Info:   0 out of   7 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned","Info:   3 out of   3 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"63 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-hxwm-x553-x359","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm","Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T22:07:52.187Z","repository_id":31113826,"created_at":"2025-08-19T22:07:52.187Z","updated_at":"2025-08-19T22:07:52.187Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278734383,"owners_count":26036402,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","nodejs","npm","npm-package","waka","wakatime","wakatime-api"],"created_at":"2024-08-01T18:01:26.117Z","updated_at":"2025-10-07T06:38:14.621Z","avatar_url":"https://github.com/jaebradley.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"![Wakatime Client](https://github.com/jaebradley/wakatime-client/workflows/Wakatime%20Client/badge.svg)\n[![npm](https://img.shields.io/npm/v/wakatime-client.svg)](https://www.npmjs.com/package/wakatime-client)\n[![npm-total-downloads](https://img.shields.io/npm/dt/wakatime-client.svg)](https://www.npmjs.com/package/wakatime-client)\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/wakatime-client)\n![Codecov branch](https://img.shields.io/codecov/c/gh/jaebradley/wakatime-client/master)\n![GitHub](https://img.shields.io/github/license/jaebradley/wakatime-client)\n\n# wakatime-client\n\nA `NodeJS` client for [the `WakaTime` API](https://wakatime.com/developers).\n\n- [WakaTime Client](#wakatime-client)\n  - [Installation](#installation)\n  - [API](#api)\n  - [Local Development](#local-development)\n\n## Installation\n\n```bash\nnpm install wakatime-client --save\n```\n\n## API\n\n* [Create Instance Using API Key](#create-instance-using-api-key)\n  * [Custom Base URLs](#custom-base-urls)\n* [`getUser`](#getuser)\n* [`getMe`](#getme)\n* [`getTeams`](#getteams)\n* [`getMyTeams`](#getmyteams)\n* [`getUserAgents`](#getuseragents)\n* [`getMyUserAgents`](#getmyuseragents)\n* [`getTeamMembers`](#getteammembers)\n* [`getMyTeamMembers`](#getmyteammembers)\n* [`getTeamMemberSummary`](#getteammembersummary)\n* [`getMyTeamMemberSummary`](#getmyteammembersummary)\n* [`getUserSummary`](#getusersummary)\n* [`getMySummary`](#getmysummary)\n* [`getUserStats`](#getuserstats)\n* [`getMyStats`](#getmystats)\n* [`getProjects`](#getprojects)\n* [`getMyProjects`](#getmyprojects)\n* [`getLeaders`](#getleaders)\n* [`getHeartbeats`](#getheartbeats)\n* [`getMyHeartbeats`](#getmyheartbeats)\n* [`getGoals`](#getgoals)\n* [`getMyGoals`](#getmygoals)\n* [`getDurations`](#getdurations)\n* [`getMyDurations`](#getmydurations)\n* [`getCommits`](#getcommits)\n* [`getMyCommits`](#getmycommits)\n* [`getMetadata`](#getmetadata)\n* [`getOrganizations`](#getorganizations)\n* [`getMyOrganizations`](#getmyorganizations)\n* [`getOrganizationDashboards`](#getorganizationdashboards)\n* [`getMyOrganizationDashboards`](#getmyorganizationdashboards)\n* [`getOrganizationDashboardMembers`](#getorganizationdashboardmembers)\n* [`getMyOrganizationDashboardMembers`](#getmyorganizationdashboardmembers)\n* [`getOrganizationDashboardMemberSummaries`](#getorganizationdashboardmembersummaries)\n* [`getMyOrganizationDashboardMemberSummaries`](#getmyorganizationdashboardmembersummaries)\n* [`getOrganizationDashboardMemberDurations`](#getorganizationdashboardmemberdurations)\n* [`getMyOrganizationDashboardMemberDurations`](#getmyorganizationdashboardmemberdurations)\n\n### Create Instance Using API Key\n\n```javascript\nimport { WakaTimeClient } from 'wakatime-client';\n\nconst client = new WakaTimeClient('some api key');\n```\n\n#### Custom Base URLs\n```javascript\nimport { WakaTimeClient } from 'wakatime-client';\n\nconst client = new WakaTimeClient('some api key', 'https://wakapi.dev/api/v1');\n```\n\n### `getUser`\n\nGet details for user\n\n```javascript\nconst userDetails = await client.getUser('some user id');\n```\n\n### `getMe`\n\nGet details for user associated with API key\n\n```javascript\nconst myUserDetails = await client.getMe();\n```\n\n### `getTeams`\n\nGet teams for user\n\n```javascript\nconst teams = await client.getTeams('some user id');\n```\n\n### `getMyTeams`\n\nGet teams for user associated with API key\n\n```javascript\nconst myTeams = await client.getMyTeams();\n```\n\n### `getUserAgents`\n\nGet `User Agents` (or plugins) for user\n\n```javascript\nconst userAgents = await client.getUserAgents('some user id');\n```\n\n### `getMyUserAgents`\n\nGet `User Agents` (or plugins) for user associated with API key\n\n```javascript\nconst myUserAgents = await client.getMyUserAgents();\n```\n\n### `getTeamMembers`\n\nGet team members for specified user and team\n\n```javascript\nconst teamMembers = await client.getTeamMembers({ userId: 'some user id', teamId: 'some team id' });\n```\n\n### `getMyTeamMembers`\n\nGet team members for user associated with API key and specified team\n\n```javascript\nconst myTeamMembers = await client.getMyTeamMembers('some team id');\n```\n\n### `getTeamMemberSummary`\n\nGet summary for team member\n\n#### Required Parameters\n\n```javascript\nconst teamMemberSummary = await client.getTeamMemberSummary({\n  userId: 'some user id',\n  teamId: 'some team id',\n  teamMemberId: 'some team member id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n});\n```\n\n#### With Optional Parameters\n\n```javascript\nconst teamMemberSummary = await client.getTeamMemberSummary({\n  userId: 'some user id',\n  teamId: 'some team id',\n  teamMemberId: 'some team member id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n});\n```\n\n### `getMyTeamMemberSummary`\n\nGet summary for team member for user associated with API key\n\n#### Required Parameters\n\n```javascript\nconst myTeamMemberSummary = await client.getMyTeamMemberSummary({\n  teamId: 'some team id',\n  teamMemberId: 'some team member id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n});\n```\n\n#### With Optional Parameters\n\n```javascript\nconst myTeamMemberSummary = await client.getMyTeamMemberSummary({\n  teamId: 'some team id',\n  teamMemberId: 'some team member id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n});\n```\n\n### `getUserSummary`\n\nGet summary for user\n\n#### Required Parameters\n\n```javascript\nconst summary = await client.getUserSummary({\n  userId: 'some user id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n})\n```\n\n#### With Optional Parameters\n\n```javascript\nconst summary = await client.getUserSummary({\n  userId: 'some user id',\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n})\n```\n\n### `getMySummary`\n\nGet summary for user associated with API key\n\n#### Required Parameters\n\n```javascript\nconst summary = await client.getMySummary({\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n})\n```\n\n#### With Optional Parameters\n\n```javascript\nconst summary = await client.getMySummary({\n  dateRange: {\n    startDate: 'some start date',\n    endDate: 'some end date',\n  },\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n})\n```\n\n### `getUserStats`\n\nGet stats for user\n\n#### Required Parameters\n\n```javascript\nimport { RANGE } from 'wakatime-client';\n\n// I assume you have instantiated the client\n\nconst stats = await client.getUserStats({\n  userId: 'some user id',\n  range: RANGE.PAST_7_DAYS,\n});\n```\n\n#### With Optional Parameters\n\n```javascript\nimport { RANGE } from 'wakatime-client';\n\n// I assume you have instantiated the client\n\nconst stats = await client.getUserStats({\n  userId: 'some user id',\n  range: RANGE.PAST_7_DAYS,\n  timeout: 'some timeout',\n  useWritesOnly: true,\n  projectName: 'some project name',\n});\n```\n\n### `getMyStats`\n\nGet stats for user associated with API key\n\n#### Required Parameters\n\n```javascript\nimport { RANGE } from 'wakatime-client';\n\n// I assume you have instantiated the client\n\nconst myStats = await client.getMyStats({ range: RANGE.PAST_7_DAYS });\n```\n\n#### With Optional Parameters\n\n```javascript\nimport { RANGE } from 'wakatime-client';\n\n// I assume you have instantiated the client\n\nconst myStats = await client.getMyStats({\n  range: RANGE.PAST_7_DAYS,\n  timeout: 'some timeout',\n  useWritesOnly: true,\n  projectName: 'some project name',\n});\n```\n\n### `getProjects`\n\nGet projects for user\n\n```javascript\nconst projects = await client.getProjects('some user id');\n```\n\n### `getMyProjects`\n\nGet projects for user associated with API key\n\n```javascript\nconst myProjects = await client.getMyProjects();\n```\n\n### `getLeaders`\n\nGet Leaders\n\n#### Leaders, regardless of language\n\n```javascript\nconst leaders = await client.getLeaders();\n```\n\n#### JavaScript Leaders on Page 2\n\n```javascript\nconst leaders = await client.getLeaders({ language: 'JavaScript', pageNumber: 2 });\n```\n\n### `getHeartbeats`\n\nGet heartbeats for user on a specified date\n\n```javascript\nconst heartbeats = await client.getHeartbeats({ userId: 'some user id', date: 'some date' });\n```\n\n### `getMyHeartbeats`\n\nGet heartbeats for user associated with API key on a specified date\n\n```javascript\nconst myHeartbeats = await client.getMyHeartbeats('some date');\n```\n\n### `getGoals`\n\nGet goals for user\n\n```javascript\nconst goals = await client.getGoals('some user id');\n```\n\n### `getMyGoals`\n\nGet goals for user associated with API key\n\n```javascript\nconst myGoals = await client.getMyGoals();\n```\n\n### `getDurations`\n\nGet durations for user\n\n#### Required Parameters\n\n```javascript\nconst durations = await client.getDurations({ userId: 'some user id', date: 'some date' });\n```\n\n#### With Optional Parameters\n\n```javascript\nconst durations = await client.getDurations({\n  userId: 'some user id',\n  date: 'some date',\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n});\n```\n\n### `getMyDurations`\n\nGet durations for user associated with API key\n\n#### Required Parameters\n\n```javascript\nconst myDurations = await client.getMyDurations({ date: 'some date' });\n```\n\n#### With Optional Parameters\n\n```javascript\nconst myDurations = await client.getMyDurations({\n  date: 'some date',\n  projectName: 'some project name',\n  branchNames: ['some branch', 'some other branch', 'some other other branch'],\n});\n```\n\n### `getCommits`\n\nGet commits for user\n\n#### Required Parameters\n\n```javascript\nconst commits = await client.getCommits({\n  userId: 'some user id',\n  projectName: 'some project name',\n});\n```\n\n#### With Optional Parameters\n\n```javascript\nconst commits = await client.getCommits({\n  userId: 'some user id',\n  projectName: 'some project name',\n  authorName: 'jaebaebae',\n  pageNumber: 2,\n});\n```\n\n### `getMyCommits`\n\nGet commits for user associated with API key\n\n#### Required Parameters\n\n```javascript\nconst myCommits = await client.getMyCommits({ projectName: 'some project name' });\n```\n\n#### With Optional Parameters\n\n```javascript\nconst myCommits = await client.getMyCommits({\n  projectName: 'some project name',\n  authorName: 'jaebaebae',\n  pageNumber: 2,\n});\n```\n\n### `getMetadata`\n\nGet metadata associated with WakaTime service (like IP addresses)\n\n```javascript\nconst metadata = await client.getMetadata();\n```\n\n### `getOrganizations`\n\nGet list of organizations for the specified user\n\n```javascript\nconst organizations = await client.getOrganizations('some user id');\n```\n\n### `getMyOrganizations`\n\nGet list of organizations for user associated with API key\n\n```javascript\nconst myOrganizations = await client.getMyOrganizations();\n```\n\n### `getOrganizationDashboards`\n\nGet list of dashboards for the specified user and organization\n\n```javascript\nconst dashboards = await client.getOrganizationDashboards({ \n  userId: 'some user id', \n  organizationId: 'some organization id',\n});\n```\n\n### `getMyOrganizationDashboards`\n\nGet list of dashboards for the current user and the specified organization\n\n```javascript\nconst dashboards = await client.getMyOrganizationDashboards('some organization id');\n```\n\n### `getOrganizationDashboardMembers`\n\nGet list of dashboard members for the specified user, organization, and dashboard\n\n```javascript\nconst members = await client.getOrganizationDashboardMembers({\n  userId: 'some user id',\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n})\n```\n\n### `getMyOrganizationDashboardMembers`\n\nGet list of dashboard members for the current user and specified organization and dashboard\n\n```javascript\nconst members = await client.getMyOrganizationDashboardMembers({\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n})\n```\n\n### `getOrganizationDashboardMemberSummaries`\n\nGet list of dashboard member summaries for the specified user, organization, dashboard, and member\n\n```javascript\nconst summaries = await client.getOrganizationDashboardMemberSummaries({\n  userId: 'some user id',\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n  memberId: 'some member id',\n})\n```\n\n### `getMyOrganizationDashboardMemberSummaries`\n\nGet list of dashboard member summaries for the current user and specified organization, dashboard, and member\n\n```javascript\nconst summaries = await client.getMyOrganizationDashboardMemberSummaries({\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n  memberId: 'some member id',\n})\n```\n\n### `getOrganizationDashboardMemberDurations`\n\nGet list of dashboard member durations for the specified user, organization, dashboard, and member\n\n```javascript\nconst summaries = await client.getOrganizationDashboardMemberDurations({\n  userId: 'some user id',\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n  memberId: 'some member id',\n})\n```\n\n### `getMyOrganizationDashboardMemberDurations`\n\nGet list of dashboard member durations for the current user and specified organization, dashboard, and member\n\n```javascript\nconst summaries = await client.getMyOrganizationDashboardMemberDurations({\n  organizationId: 'some organization id',\n  dashboardId: 'some dashboard id',\n  memberId: 'some member id',\n})\n```\n\n## Local Development\n\nAfter cloning the repository, use `nvm` / `npm` to install dependencies.\n\nTo run tests, execute `npm run test`. This will run both unit and integration tests.\n\nIn order to execute local integration tests successfully, you'll need to specify the following environment variables in the `.env` file as well as in the `Secrets` section of your fork's `Settings` page.\n\n- `ACCESS_TOKEN` (A WakaTime Access Token)\n- `USER_ID` (A WakaTime User ID)\n- `ORGANIZATION_ID` ( A WakaTime Organization ID)\n- `DASHBOARD_ID` (A WakaTime Dashboard ID)\n\nTo build the production bundle, execute `npm run build`.\n\n### Git Hooks\n\nThis project uses [`husky`](https://github.com/typicode/husky) to maintain git hooks.\n\n- `pre-commit` - run `eslint`\n- `commit-msg` - run commit message linting\n- `pre-push` - run tests\n\n### Commit Linting\n\nThis project uses [`semantic-release`](https://github.com/semantic-release/semantic-release) and [`commitlint`](https://github.com/conventional-changelog/commitlint) (specifically the [Angular commit convention](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)) to automatically enforce semantic versioning.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaebradley%2Fwakatime-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjaebradley%2Fwakatime-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjaebradley%2Fwakatime-client/lists"}