| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://wakatime.com/api/v1 | link | — | — | — |
Actions (90)
Users · 37
- Bulk create heartbeatsPOST /api/v1/users/{user}/heartbeats.bulk
Create multiple heartbeats in a single request for a user.
documented - Bulk create heartbeats (current user)POST /api/v1/users/current/heartbeats.bulk
Create multiple heartbeats in a single request for the current user.
documented - Bulk delete heartbeatsDELETE /api/v1/users/{user}/heartbeats.bulk
Permanently delete multiple heartbeats for a user.
documented - Bulk delete heartbeats (current user)DELETE /api/v1/users/current/heartbeats.bulk
Permanently delete multiple heartbeats for the current user.
documented - Cancel custom rules progressDELETE /api/v1/users/{user}/custom_rules_progress
Abort applying current custom rules to user’s past code stats.
documented - Cancel custom rules progress (current user)DELETE /api/v1/users/current/custom_rules_progress
Abort applying current custom rules to the current user’s past code stats.
documented - Create data dumpPOST /api/v1/users/{user}/data_dumps
Create a data export containing the user’s code stats as daily Summaries.
documented - Create data dump (current user)POST /api/v1/users/current/data_dumps
Create a data export for the current user.
documented - Create data dump (current user, extended)POST /api/v1/users/current/data_dumps
Create a data export for the current user (extended).
documented - Create data dump (extended)POST /api/v1/users/{user}/data_dumps
Create a data export for the user (extended).
documented - Create heartbeatPOST /api/v1/users/{user}/heartbeats
Create a heartbeat for a user.
documented - Create heartbeat (current user)POST /api/v1/users/current/heartbeats
Create a heartbeat for the current user.
documented - Delete custom ruleDELETE /api/v1/users/{user}/custom_rules/{rule_id}
Delete a single custom rule for this user.
documented - Delete custom rule (current user)DELETE /api/v1/users/current/custom_rules/{rule_id}
Delete a single custom rule for the current user.
documented - Get current userGET /api/v1/users/current
Get details for the currently authenticated user.
documented - Get custom rules progressGET /api/v1/users/{user}/custom_rules_progress
Check background progress of applying custom rules to the user’s past code stats.
documented - Get custom rules progress (current user)GET /api/v1/users/current/custom_rules_progress
Check background progress of applying custom rules to the current user’s past code stats.
documented - Get data dump (export)GET /api/v1/users/{user}/data_dumps
Retrieve details about a data export (status and metadata).
documented - Get goalGET /api/v1/users/{user}/goals/{goal}
Get a single goal for the user.
documented - Get goal (current user)GET /api/v1/users/current/goals/{goal}
Get a single goal for the current user.
documented - Get userGET /api/v1/users/{user}
Get details for a specific user.
documented - List custom rulesGET /api/v1/users/{user}/custom_rules
List custom rules for this user.
documented - List custom rules (current user)GET /api/v1/users/current/custom_rules
List custom rules for the currently authenticated user.
documented - List data dumpsGET /api/v1/users/{user}/data_dumps
List data exports available for the user.
documented - List data dumps (current user)GET /api/v1/users/current/data_dumps
List data exports available for the current user.
documented - List external durations (current user)GET /api/v1/users/current/external_durations
List a current user’s external durations for a day.
documented - List external durations (user)GET /api/v1/users/{user}/external_durations
List a user’s external durations for a day.
documented - List goalsGET /api/v1/users/{user}/goals
List a user’s goals.
documented - List goals (current user)GET /api/v1/users/current/goals
List the current user’s goals.
documented - List heartbeatsGET /api/v1/users/{user}/heartbeats
List a user’s heartbeats for a given day.
documented - List heartbeats (current user)GET /api/v1/users/current/heartbeats
List the current user’s heartbeats for a given day.
documented - List insights (current user) by type and rangeGET /api/v1/users/current/insights/{insight_type}/{range}
List coding insights for the current user by type and time range.
documented - List insights by type and rangeGET /api/v1/users/{user}/insights/{insight_type}/{range}
List coding insights for a user by type and time range.
documented - List machine names (current user)GET /api/v1/users/current/machine_names
List machines used by the current user.
documented - List machine names (user)GET /api/v1/users/{user}/machine_names
List machines used by the user.
documented - Update custom rulesPUT /api/v1/users/{user}/custom_rules
Replace/update the user’s custom rules with a provided array.
documented - Update custom rules (current user)PUT /api/v1/users/current/custom_rules
Replace/update the current user’s custom rules with a provided array.
documented
Projects · 8
- Get commit for projectGET /api/v1/users/{user}/projects/{project}/commits/{hash}
Return a single commit entry for a project showing time spent coding on that commit.
documented - Get commit for project (current user)GET /api/v1/users/current/projects/{project}/commits/{hash}
Return a single commit entry for a project for the current authenticated user.
documented - List commits for a projectGET /api/v1/users/{user}/projects/{project}/commits
List commits for a WakaTime project showing time coded in each commit.
documented - List commits for a project (current user)GET /api/v1/users/current/projects/{project}/commits
List commits for a WakaTime project for the current authenticated user.
documented - List current user projectsGET /api/v1/users/current/projects
List projects for the currently authenticated user.
documented - List user projectsGET /api/v1/users/{user}/projects
List all projects for a user.
documented - Search current user projectsGET /api/v1/users/current/projects
Filter the current user’s projects by a search term (query parameter 'q').
documented - Search user projectsGET /api/v1/users/{user}/projects
Filter projects by a search term (query parameter 'q').
documented
Org Custom Rules · 6
- Delete org custom ruleDELETE /api/v1/users/{user/orgs}/{org}/custom_rules/{rule_id}
Delete a specific org custom rule.
documented - Delete org custom rule (current user)DELETE /api/v1/users/current/orgs/{org}/custom_rules/{rule_id}
Delete a specific org custom rule (current user context).
documented - List org custom rulesGET /api/v1/users/{user/orgs}/{org}/custom_rules
List custom rules for an organization.
documented - List org custom rules (current user)GET /api/v1/users/current/orgs/{org}/custom_rules
List custom rules for an organization (current user context).
documented - Update org custom rulesPUT /api/v1/users/{user/orgs}/{org}/custom_rules
Update an organization’s custom rules.
documented - Update org custom rules (current user)PUT /api/v1/users/current/orgs/{org}/custom_rules
Update an organization’s custom rules (current user context).
documented
Stats · 6
- Get all-time activity since account creation (current user)GET /api/v1/users/current/all_time_since_today
Return total coding time since the current authenticated user’s account creation (optionally filtered by project).
documented - Get all-time activity since account creation (user)GET /api/v1/users/{user}/all_time_since_today
Return total coding time since the specified user’s account creation (optionally filtered by project).
documented - Get current user statsGET /api/v1/users/current/stats
Retrieve stats for the authenticated user.
documented - Get current user stats by rangeGET /api/v1/users/current/stats/{range}
Retrieve stats for the authenticated user over a specific range.
documented - Get user statsGET /api/v1/users/{user}/stats
Retrieve stats for a user.
documented - Get user stats by rangeGET /api/v1/users/{user}/stats/{range}
Retrieve stats for a user over a specific range.
documented
Org Dashboards · 4
- Get orgGET /api/v1/users/{user/orgs}/{org}
Get org information for a user.
documented - Get org (current user)GET /api/v1/users/current/orgs/{org}
Get org information for the current user.
documented - Get org dashboardGET /api/v1/users/{user/orgs}/{org}/dashboards/{dashboard}
Get a specific org dashboard.
documented - Get org dashboard (current user)GET /api/v1/users/current/orgs/{orgs}/dashboards/{dashboard}
Get a specific org dashboard (current user context).
documented
Orgs · 4
- Get org detailsGET /api/v1/orgs/{org}
Get details for a specific organization.
documented - Get org leaderboardsGET /api/v1/orgs/{org}/leaderboards
List leaderboards for a specific organization.
documented - Get org leadersGET /api/v1/orgs/{org}/leaders
List leaders for a specific organization.
documented - List all orgs (available to the caller)GET /api/v1/orgs
List organizations available to the authenticated caller.
documented
Summaries · 4
- List current user summariesGET /api/v1/users/current/summaries
List the current user’s daily summaries.
documented - List current user summaries (dependent)GET /api/v1/users/current/summaries
List the current user’s daily summaries with additional parameters.
documented - List user summariesGET /api/v1/users/{user}/summaries
List a user’s daily summaries.
documented - List user summaries (dependent)GET /api/v1/users/{user}/summaries
List a user’s daily summaries with additional parameters.
documented
Status Bar · 3
- Get global status bar todayGET /api/v1/status_bar/today
Public status bar for today (no user required).
documented - Get status bar today (current user)GET /api/v1/users/current/status_bar/today
Today's coding activity for the current authenticated user (cached).
documented - Get user status bar todayGET /api/v1/users/{user}/status_bar/today
Today's coding activity for a specific user (cached).
documented
Heartbeats · 2
Meta · 2
Org Dashboard Durations · 2
- List org dashboard durationsGET /api/v1/users/{user/orgs}/{org}/dashboards/{dashboard}/durations
List durations for a given org dashboard.
documented - List org dashboard durations (current user)GET /api/v1/users/current/orgs/{orgs}/dashboards/{dashboard}/durations
List durations for an org dashboard (current user context).
documented
Org Dashboard Member Durations · 2
- List org dashboard member durationsGET /api/v1/users/{user/orgs}/{org}/dashboards/{dashboard}/members/{member}/durations
List a member’s durations on an org dashboard.
documented - List org dashboard member durations (current user)GET /api/v1/users/current/orgs/{orgs}/dashboards/{dashboard}/members/{member}/durations
List a member’s durations on an org dashboard (current user context).
documented
Org Dashboard Member Summaries · 2
- List org dashboard member summariesGET /api/v1/users/{user/orgs}/{org}/dashboards/{dashboard}/members/{member}/summaries
List a org dashboard member’s summaries.
documented - List org dashboard member summaries (current user)GET /api/v1/users/current/orgs/{orgs}/dashboards/{dashboard}/members/{member}/summaries
List a org dashboard member’s summaries (current user context).
documented
Org Dashboard Summaries · 2
- List org dashboard summariesGET /api/v1/users/{user/orgs}/{org}/dashboards/{dashboard}/summaries
List an org dashboard’s summaries.
documented - List org dashboard summaries (current user)GET /api/v1/users/current/orgs/{orgs}/dashboards/{dashboard}/summaries
List an org dashboard’s summaries (current user context).
documented