### Example Response for Meta Information

Source: https://wakatime.com/developers

This is an example JSON response for the GET /api/v1/meta endpoint, providing information about WakaTime servers and IP addresses.

```json
{
  "data": {
    "ip_descriptions": <object: explanation of each ip category (api, website, worker)>,
    "ips": {
      "api": <list of strings: ip addresses used by WakaTime api servers>,
      "website": <list of strings: ip addresses used by WakaTime website servers>,
      "worker": <list of strings: ip addresses used by WakaTime background worker servers>
    },
    "last_modified_at": <string: last time an IP was either added, removed, or modified in ISO 8601 format; use similar to etag, to sync your firewall configs only when IPs have changed>
  },
}
```

--------------------------------

### Example Response for Machine Names

Source: https://wakatime.com/developers

This is an example JSON response for the GET /api/v1/users/:user/machine_names endpoint, detailing the structure of machine information.

```json
{
  "data": {
    "id": <string: unique id of this machine>,
    "name": <string: the machine’s name, normally the host name; when user’s preference is to show IPs in machine names, this will include the IP address of the machine.>,
    "value": <string: local host name of this machine>,
    "ip": <string: ip address of this machine>,
    "last_seen_at": <string: time when this machine was last seen in ISO 8601 format>,
    "timezone": <string: timezone sent with first heartbeat received for this machine, in Olson Country/Region format>,
    "created_at": <string: time when this machine was first seen in ISO 8601 format>,
  },
}
```

--------------------------------

### List User Projects API Response

Source: https://wakatime.com/developers

Example response for the GET /api/v1/users/:user/projects or GET /api/v1/users/current/projects endpoints, detailing user projects and their associated metadata.

```json
{
  "data": [
    {
      "id": <string: unique project id>,
      "name": <string: project name>,
      "repository": <string: associated repository if connected>,
      "badge": <string: associated project badge if enabled>,
      "color": <string: custom project color as hex string, or null if using default color>,
      "clients": <list: clients associated with this project>,
      "has_public_url": <boolean: whether this project has a shareable url defined>,
      "human_readable_last_heartbeat_at": <string: time when project last received code stats as human readable string>,
      "last_heartbeat_at": <string: time when project last received code stats in ISO 8601 format>,
      "human_readable_first_heartbeat_at": <string: time when project first received code stats as human readable string; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC>,
      "first_heartbeat_at": <string: time when project first received code stats in ISO 8601 format; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC>,
      "url": <string: url of this project relative to wakatime.com>,
      "urlencoded_name": <string: project name url entity encoded>,
      "created_at": <string: time when project was created in ISO 8601 format>
    }, …
  ]
}
```

--------------------------------

### Example Response for Listing Custom Rules

Source: https://wakatime.com/developers

This is an example of the JSON response when listing custom rules for an organization. It shows the structure of the 'data' array containing individual rule configurations.

```json
{
  "data": [
    {
      "action": <string: either "change" or "delete">
      "source": <string: the heartbeat property to match against source_value>,
      "operation": <string: one of "equals", "contains", "starts with", or "ends with">
      "source_value": <string: the match string>,
      "destinations": [
        {
          "id": <string: unique id of this custom rule destination>,
          "destination": <string: the heartbeat property to replace with destination_value>,
          "destination_value": <string: the replacement string>,
        }, …
      ],
      "priority": <integer: a unique number determining the order this rule is executed on heartbeats; starts with 1; lower priorities are executed before higher priorities>,
    }, …
  ],
}
```

--------------------------------

### Status Bar API Example Response (200 OK)

Source: https://wakatime.com/developers

This is an example of a successful response (200 OK) from the Status Bar API. It includes details about coding activity, categorized by projects, languages, editors, and operating systems.

```json
{
  "cached_at": <string: when this response was calculated and cached as ISO 8601 UTC datetime>,
  "has_team_features": <boolean: true if user has access to team features>,
  "data": {
    "grand_total": {
      "decimal": <string: total coding activity in decimal format>,
      "digital": <string: total coding activity in digital clock format>,
      "hours": <integer: hours portion of coding activity>,
      "minutes": <integer: minutes portion of coding activity>,
      "text": <string: total coding activity in human readable format>,
      "total_seconds": <float: total coding activity as seconds>
    },
    "categories": [
      {
        "name": <string: name of category, for ex: Coding or Debugging>,
        "total_seconds": <float: total coding activity as seconds>,
        "percent": <float: percent of time spent in this category>,
        "decimal": <string: total coding activity for this category in decimal format>,
        "digital": <string: total coding activity for this category in digital clock format>,
        "text": <string: total coding activity in human readable format>,
        "hours": <integer: hours portion of coding activity for this category>,
        "minutes": <integer: minutes portion of coding activity for this category>
      }, …
    ],
    "projects": [
      {
        "name": <string: project name>,
        "total_seconds": <float: total coding activity as seconds>,
        "percent": <float: percent of time spent in this project>,
        "decimal": <string: total coding activity for this project in decimal format>,
        "digital": <string: total coding activity for this project in digital clock format>,
        "text": <string: total coding activity in human readable format>,
        "hours": <integer: hours portion of coding activity for this project>,
        "minutes": <integer: minutes portion of coding activity for this project>
      }, …
    ],
    "languages": [
      {
        "name": <string: language name>,
        "total_seconds": <float: total coding activity spent in this language as seconds>,
        "percent": <float: percent of time spent in this language>,
        "decimal": <string: total coding activity for this language in decimal format>,
        "digital": <string: total coding activity for this language in digital clock format>,
        "text": <string: total coding activity in human readable format>,
        "hours": <integer: hours portion of coding activity for this language>,
        "minutes": <integer: minutes portion of coding activity for this language>,
        "seconds": <integer: seconds portion of coding activity for this language>
      }, …
    ],
    "editors": [
      {
        "name": <string: editor name>,
        "total_seconds": <float: total coding activity spent in this editor as seconds>,
        "percent": <float: percent of time spent in this editor>,
        "decimal": <string: total coding activity for this editor in decimal format>,
        "digital": <string: total coding activity for this editor in digital clock format>,
        "text": <string: total coding activity in human readable format>,
        "hours": <integer: hours portion of coding activity for this editor>,
        "minutes": <integer: minutes portion of coding activity for this editor>,
        "seconds": <integer: seconds portion of coding activity for this editor>
      }, …
    ],
    "operating_systems": [
      {
        "name": <string: os name>,
        "total_seconds": <float: total coding activity spent in this os as seconds>,
        "percent": <float: percent of time spent in this os>,
        "decimal": <string: total coding activity for this os in decimal format>,
        "digital": <string: total coding activity for this os in digital clock format>

```

--------------------------------

### Example Response for All Time Since Today API

Source: https://wakatime.com/developers

This is an example JSON response for the /api/v1/users/:user/all_time_since_today endpoint, showing total coding activity since account creation. It includes daily averages, decimal and digital formats, and range details.

```json
{
  "data": {
    "daily_average": <float: average coding activity per day as seconds for the given range of time, including Other language>,
    "decimal": <string: total coding activity in decimal format>,
    "digital": <string: total coding activity in digital clock format>,
    "is_up_to_date": <boolean: true if the stats are up to date; when false, a 200 response code is returned and stats will be refreshed soon>,
    "percent_calculated": <integer: a number between 0 and 100 where 100 means the stats are up to date including Today’s time>,
    "range": {
      "end": <string: end of today as ISO 8601 UTC datetime>,
      "end_date": <string: today as Date string in YEAR-MONTH-DAY format>,
      "end_text": <string: today in human-readable format>,
      "start": <string: start of user created day as ISO 8601 UTC datetime>,
      "start_date": <string: day user was created in YEAR-MONTH-DAY format>,
      "start_text": <string: day user was created in human-readable format>,
      "timezone": <string: timezone used in Olson Country/Region format>
    },
    "text": <string: total time logged since account created as human readable string>,
    "timeout": <integer: keystroke timeout setting in minutes>,
    "total_seconds": <float: total number of seconds logged since account created>
  }
}
```

--------------------------------

### List Program Languages API Response

Source: https://wakatime.com/developers

Example response for the GET /api/v1/program_languages endpoint, listing supported programming languages and their attributes.

```json
{
  "data": [
    "id": <string: unique id of this language>,
    "name": <string: human readable name of this language>
    "color": <string: hex color code, used when displaying this language on WakaTime charts>,
    "is_verified": <boolean: whether this language is verified, by GitHub’s linguist or manually by WakaTime admins>,
    "created_at": <string: time when this language was created in ISO 8601 format>,
    "modified_at": <string: time when this language was last modified in ISO 8601 format>
  ], …
  "total": <integer: number of program languages>,
  "total_pages": <integer: number of pages>,
}
```

--------------------------------

### Example Response for Updating Custom Rules

Source: https://wakatime.com/developers

This is an example of the JSON response after successfully updating an organization's custom rules. It indicates any changes made, such as added, removed, or rearranged rules.

```json
{
  "data": {
    "changes": {
      "added": [],
      "removed": [],
      "rearranged": [],
    }
  }
}
```

--------------------------------

### WakaTime API Example Response

Source: https://wakatime.com/developers

This is an example of a JSON response from the WakaTime API, illustrating the structure of goal data and related information. It includes details about coding activity, goals, and user profiles.

```json
{
  "cached_at": <string: when this response was calculated and cached as ISO 8601 UTC datetime>,
  "data": {
    "average_status": <string: "fail" when there are more failure days or weeks than success, otherwise "success">
    "chart_data": [
      {
        "actual_seconds": <float: number of seconds coded during this delta period>,
        "actual_seconds_text": <string: human readable time coded during this delta period>,
        "goal_seconds": <integer: number of seconds required to meet goal for this delta period>,
        "goal_seconds_text": <string: human readable coding time required to meet goal for this delta period>,
        "range": {
          "date": <string: current time range as Date string in YEAR-MONTH-DAY format (only available when delta is "day")>,
          "end": <string: end of current time range as ISO 8601 UTC datetime>,
          "start": <string: start of current time range as ISO 8601 UTC datetime>,
          "text": <string: current range in human-readable format relative to the current day>,
          "timezone": <string: timezone used in Olson Country/Region format>
        },
        "range_status": <string: either "success", "fail", "pending", or "ignored">
        "range_status_reason": <string: an explanation for why this delta period passed or failed>
      }, …
    ],
    "created_at": <string: time when this goal was created in ISO 8601 format>,
    "cumulative_status": <string: status over all delta periods, either "success", "fail", or "ignored">
    "custom_title": <string: user defined custom title for this goal, overwrites goal title if defined>,
    "delta": <string: goal step duration; either "day" or "week">
    "editors": <list of strings: editors for this goal>,
    "id": <string: unique id of goal>,
    "ignore_days": <list of strings: goal status set to "ignored" instead of "failed" for these weekdsays, when delta is "day">
    "ignore_zero_days": <boolean: ignore days with no coding activity>,
    "improve_by_percent": <float: percent goal should increase each delta>,
    "is_current_user_owner": <boolean: whether the currently authenticated user is the owner of this goal>,
    "is_enabled": <boolean: whether this goal is enabled or disabled>,
    "is_inverse": <boolean: when true, the goal is to code less not more>,
    "is_snoozed": <boolean: goal email notifications are temporarily disabled until the date defined by snooze_until>,
    "is_tweeting": <boolean: this goal is setup to tweet progress each day>,
    "languages": <list of strings: languages for this goal>,
    "modified_at": <string: optional time when this goal was last changed in ISO 8601 format>,
    "owner": {
      "display_name": <string: display name of this user taken from full_name or @username. Defaults to 'Anonymous User'>,
      "email": <string: email address>,
      "full_name": <string: full name of user>,
      "id": <string: unique id of user>,
      "photo": <string: url of photo for this user>,
      "username": <string: user's public username>,
    },
    "projects": <list of strings: projects for this goal>,
    "range_text": <string: complete range of this goal for all delta periods in human-readable format>,
    "seconds": <integer: goal amount>,
    "shared_with": [
      {
        "display_name": <string: display name of this user taken from full_name or @username. Defaults to 'Anonymous User'>,
        "email": <string: user's email, only defined if shared via email address>,
        "full_name": <string: full name of user>,
        "id": <string: unique id of user>,
        "photo": <string: url of photo for this user>,
        "status": <string: whether this invitation has been accepted or not by the other user>,
        "user_id": <string: user's id, only defined if shared via user id>,
        "username": <string: username, only defined if shared via username>,
      }, …
    ],
    "snooze_until": <string: optional time when goal email notifications will be re-enabled, in ISO 8601 format>,
    "status": <string: most recent day or week range status; can be "success", "fail", "ignored", or "pending">
    "status_percent_calculated": <integer: for goals which are pre-calculated in the background, the percent completed until this goal's status will be available>,
    "subscribers": [
      {
        "email": <string: email address of this subscriber, if public>,
        "email_frequency": <string: how often this subscriber receives emails about this goal>,
        "full_name": <string: name of this subscriber, if public>,
        "user_id": <string: unique id of this subscriber>,
        "username": <string: username of this subscriber, if defined>
      }, …
    ],
    "title": <string: human readable title for this goal>,
    "type": <string: type of goal>
  }
}
```

--------------------------------

### WakaTime Project Commits API Response Example

Source: https://wakatime.com/developers

This is an example of the JSON response received when querying the WakaTime API for project commits. It includes details about each commit, author, committer, and project repository information.

```json
{
  "commits": [
    {
      "author_avatar_url": <string: url of author's avatar image>
      "author_date": <string: time when commit was authored in ISO 8601 format>,
      "author_email": <string: email address of author>,
      "author_html_url": <string: link to author's profile on GitHub, Bitbucket, GitLab, etc>,
      "author_name": <string: name of author>,
      "author_url": <string: api url for author's profile>,
      "author_username": <string: author's username>,
      "branch": <string: branch name, for ex: master>,
      "committer_avatar_url": <string: url of committer's avatar image>,
      "committer_date": <string: commit time in ISO 8601 format>,
      "committer_email": <string: email address of committer>,
      "committer_html_url": <string: link to committer's profile on GitHub, Bitbucket, GitLab, etc>,
      "committer_name": <string: name of committer>,
      "committer_url": <string: api url for committer's profile>,
      "committer_username": <string: committer's username>,
      "created_at": <string: time commit was synced in ISO 8601 format>,
      "hash": <string: revision control hash of this commit>,
      "html_url": <string: link to an html page with details about current commit>,
      "human_readable_total": <string: time coded in editor for this commit>,
      "human_readable_total_with_seconds": <string: time coded in editor for this commit>,
      "id": <string: unique id of commit>,
      "message": <string: author's description of this commit>,
      "ref": <string: refs/heads/master>,
      "total_seconds": <float: time coded in editor for this commit>,
      "truncated_hash": <string: truncated revision control hash of this commit>,
      "url": <string: api url with details about current commit>
    }, …
  ],
  "author": <string: current author or null if showing commits from all authors>,
  "next_page": <integer: next page number or null if last page>
  "next_page_url": <string: url for next page or null if last page>
  "page": <integer: current page number>
  "prev_page": <integer: previous page number or null if first page>
  "prev_page_url": <string: url for previous page or null if first page>
  "branch": <string: branch name containting the commits>,
  "project": {
    "id": <string: unique id of project>,
    "name": <string: project name>,
    "privacy": <string: project privacy setting>,
    "repository": {
      "default_branch": <string: default branch if given for this repo>,
      "description": <string: remote repository description>,
      "fork_count": <integer: number of repo forks if available>
      "full_name": <string: username and repo name, ex: wakatime/wakadump>,
      "homepage": <string: homepage of repository>,
      "html_url": <string: html url for repository>,
      "id": <string: unique id of repository>,
      "is_fork": <boolean: whether this repo is a fork or original>,
      "is_private": <boolean: whether this repo is private or public>,
      "last_synced_at": <string: last time this repo was synced with remote provider iSO 8601 format>,
      "name": <string: repository name>,
      "provider": <string: remote provider of repository, ex: github>,
      "star_count": <integer: number of repo stars if available>
      "url": <string: api url of remote repository>,
      "watch_count": <integer: number of watchers of repo if available>
    }
  },
  "status": <string: project's sync status>,
  "total": <integer: number of commits available>,
  "total_pages": <integer: number of pages available>
}
```

--------------------------------

### GET /api/v1/users/:user/user_agents

Source: https://wakatime.com/developers

List of plugins which have sent data for a specific user.

```APIDOC
## GET /api/v1/users/:user/user_agents

### Description
List of plugins which have sent data for this user.

### Method
GET

### Endpoint
/api/v1/users/:user/user_agents

### Scope Required
read_stats.editors

### Response
#### Success Response (200)
- **data** (object) - Contains user agent details.
  - **id** (string) - unique id of this user agent
  - **value** (string) - a user agent string
  - **editor** (string) - the editor/IDE name of this user agent
  - **version** (string) - the wakatime plugin version of this user agent
  - **os** (string) - operating system of this user agent
  - **last_seen_at** (string) - time when this user agent was last seen in ISO 8601 format
  - **is_browser_extension** (boolean) - true if this plugin is the browser-wakatime extension
  - **is_desktop_app** (boolean) - true if this plugin is the macos-wakatime native desktop app
  - **created_at** (string) - time when this user agent was first seen in ISO 8601 format

### Response Example
```json
{
  "data": {
    "id": "<string: unique id of this user agent>",
    "value": "<string: a user agent string>",
    "editor": "<string: the editor/IDE name of this user agent>",
    "version": "<string: the wakatime plugin version of this user agent>",
    "os": "<string: operating system of this user agent>",
    "last_seen_at": "<string: time when this user agent was last seen in ISO 8601 format>",
    "is_browser_extension": <boolean: true if this plugin is the browser-wakatime extension>,
    "is_desktop_app": <boolean: true if this plugin is the macos-wakatime native desktop app>,
    "created_at": "<string: time when this user agent was first seen in ISO 8601 format>"
  }
}
```
```

--------------------------------

### GET /api/v1/meta

Source: https://wakatime.com/developers

Retrieves meta-information about WakaTime, including public IP addresses used by WakaTime servers.

```APIDOC
## GET /api/v1/meta

### Description
Information about WakaTime, such as a list of public ip addresses used by WakaTime servers.

### Method
GET

### Endpoint
/api/v1/meta

### Response
#### Success Response (200)
- **data** (object) - Contains meta information.
  - **ip_descriptions** (object) - Explanation of each IP category (api, website, worker).
  - **ips** (object) - IP addresses used by WakaTime servers.
    - **api** (list of strings) - IP addresses used by WakaTime API servers.
    - **website** (list of strings) - IP addresses used by WakaTime website servers.
    - **worker** (list of strings) - IP addresses used by WakaTime background worker servers.
  - **last_modified_at** (string) - Last time an IP was modified (ISO 8601 format).

### Response Example
```json
{
  "data": {
    "ip_descriptions": <object: explanation of each ip category (api, website, worker)>,
    "ips": {
      "api": <list of strings: ip addresses used by WakaTime api servers>,
      "website": <list of strings: ip addresses used by WakaTime website servers>,
      "worker": <list of strings: ip addresses used by WakaTime background worker servers>
    },
    "last_modified_at": "<string: last time an IP was either added, removed, or modified in ISO 8601 format; use similar to etag, to sync your firewall configs only when IPs have changed>"
  }
}
```
```

--------------------------------

### Example API Response for Org Dashboard Durations

Source: https://wakatime.com/developers

This JSON structure represents a successful response from the API, showing coding activity broken down by project for each member. It includes start and end times, timezone, member details, and duration information.

```json
{
  "data": [
    {
      "start": <string: start of time range as ISO 8601 UTC datetime>,
      "end": <string: end of time range as ISO 8601 UTC datetime>,
      "timezone": <string: timezone used for this member’s durations in Olson Country/Region format>
      "member": {
        "id": <string: unique id of user>,
        "email": <string: email address>,
        "full_name": <string: full name of user>,
        "photo": <string: url of photo for this user>,
        "username": <string: users public username>,
        "default_personal_privacy": <string: the dev’s default personal project privacy setting, either visible or hidden>,
      },
      "durations": {
        "project": <string: project name>,
        "time": <float: start of this duration as ISO 8601 UTC datetime; numbers after decimal point are fractions of a second>,
        "duration": <float: length of time of this duration in seconds>
      }, …
    }, …
  ],
}
```

--------------------------------

### Example Commit Response

Source: https://wakatime.com/developers

This JSON object represents a single commit from a WakaTime project. It includes details about the commit author, committer, branch, message, time spent coding, and information about the associated project and its repository. This response is typically returned when a GET request is made to the commit endpoint.

```json
{
  "commit": {
    "author_avatar_url": <string: url of author's avatar image>
    "author_date": <string: time when commit was authored in ISO 8601 format>,
    "author_email": <string: email address of author>,
    "author_html_url": <string: link to author's profile on GitHub, Bitbucket, GitLab, etc>,
    "author_name": <string: name of author>,
    "author_url": <string: api url for author's profile>,
    "author_username": <string: author's username>,
    "branch": <string: branch name, for ex: master>,
    "committer_avatar_url": <string: url of committer's avatar image>,
    "committer_date": <string: commit time in ISO 8601 format>,
    "committer_email": <string: email address of committer>,
    "committer_html_url": <string: link to committer's profile on GitHub, Bitbucket, GitLab, etc>,
    "committer_name": <string: name of committer>,
    "committer_url": <string: api url for committer's profile>,
    "committer_username": <string: committer's username>,
    "created_at": <string: time commit was synced in ISO 8601 format>,
    "hash": <string: revision control hash of this commit>,
    "html_url": <string: link to an html page with details about current commit>,
    "human_readable_total": <string: time coded in editor for this commit>,
    "human_readable_total_with_seconds": <string: time coded in editor for this commit>,
    "id": <string: unique id of commit>,
    "message": <string: author's description of this commit>,
    "ref": <string: refs/heads/master>,
    "total_seconds": <float: time coded in editor for this commit>,
    "truncated_hash": <string: truncated revision control hash of this commit>,
    "url": <string: api url with details about current commit>
  },
  "branch": <string: branch name containting the commit>,
  "project": {
    "id": <string: unique id of project>,
    "name": <string: project name>,
    "privacy": <string: project privacy setting>,
    "repository": {
      "default_branch": <string: default branch if given for this repo>,
      "description": <string: remote repository description>,
      "fork_count": <integer: number of repo forks if available>
      "full_name": <string: username and repo name, ex: wakatime/wakadump>,
      "homepage": <string: homepage of repository>,
      "html_url": <string: html url for repository>,
      "id": <string: unique id of repository>,
      "is_fork": <boolean: whether this repo is a fork or original>,
      "is_private": <boolean: whether this repo is private or public>,
      "last_synced_at": <string: last time this repo was synced with remote provider iSO 8601 format>,
      "name": <string: repository name>,
      "provider": <string: remote provider of repository, ex: github>,
      "star_count": <integer: number of repo stars if available>
      "url": <string: api url of remote repository>,
      "watch_count": <integer: number of watchers of repo if available>
    }
  },
  "status": <string: project's sync status>
}
```

--------------------------------

### Example Summaries API Response

Source: https://wakatime.com/developers

This JSON structure represents a user's daily coding activity, including grand totals and breakdowns by category and project. It details metrics like total time, AI-related contributions, and category/project-specific data.

```json
{
  "data": [
    {
      "grand_total": {
        "digital": <string: total coding activity in digital clock format>,
        "hours": <integer: hours portion of coding activity>,
        "minutes": <integer: minutes portion of coding activity>,
        "text": <string: total coding activity in human readable format>,
        "total_seconds": <float: total coding activity as seconds>,
        "ai_additions": <integer: number of lines added by GenAI for this day>,
        "ai_deletions": <integer: number of lines removed by GenAI for this day>,
        "human_additions": <integer: number of lines added by old-school typing for this day>,
        "human_deletions": <integer: number of lines removed by old-school typing for this day>,
        "ai_agent_line_changes": {
          "<string: GenAI agent name>": <integer: number of lines added or removed by this GenAI agent for this day>
        },
        "ai_agent_costs": {
          "<string: GenAI agent name>": <float: estimated USD cost for this GenAI agent>
        },
        "ai_agent_breakdown": [
          {
            "name": <string: GenAI agent name>,
            "lines": <integer: number of lines added or removed by this GenAI agent for this day>,
            "cost": <float: estimated USD cost for this GenAI agent for this day>
          }, …
        ],
        "ai_agent_total_cost": <float: estimated USD cost for all GenAI agents for this day>,
        "ai_input_tokens": <integer: number of user input tokens used by GenAI tools>,
        "ai_output_tokens": <integer: number of output tokens used by GenAI tools>,
        "ai_prompt_length_avg": <integer: mean character length across all user prompts sent to AI tools, excluding null or zero prompt lengths>,
        "ai_prompt_length_avg_per_session": <integer: average across AI sessions of each session's mean prompt length; weights each session equally regardless of prompt count>,
        "ai_prompt_length_median_per_session": <integer: median across AI sessions of each session's mean prompt length; less skewed by outlier sessions than the average>,
        "ai_prompt_length_sum": <integer: sum of characters typed to AI tools>,
        "ai_prompt_events_total": <integer: number of prompts included in ai_prompt_length_avg>,
        "ai_prompt_events_avg_per_session": <integer: average number of prompts per AI session>,
        "ai_prompt_events_median_per_session": <integer: median number of prompts per AI session>,
        "ai_sessions": <integer: number of distinct AI sessions>
      },
      "categories": [
        {
          "name": <string: name of category, for ex: Coding or Debugging>,
          "total_seconds": <float: total coding activity as seconds>,
          "percent": <float: percent of time spent in this category>,
          "digital": <string: total coding activity for this category in digital clock format>,
          "text": <string: total coding activity in human readable format>,
          "hours": <integer: hours portion of coding activity for this category>,
          "minutes": <integer: minutes portion of coding activity for this category>
        }, …
      ],
      "projects": [
        {
          "name": <string: project name>,
          "total_seconds": <float: total coding activity as seconds>,
          "percent": <float: percent of time spent in this project>,
          "digital": <string: total coding activity for this project in digital clock format>,

```

--------------------------------

### Start Data Export Generation

Source: https://wakatime.com/developers

Initiate a data export in the background. An email notification is sent upon completion. Requires 'read_heartbeats' scope.

```json
{
  "type": <string: Required export type; Either 'daily' or 'heartbeats'>,
  "email_when_finished": <boolean: Optional flag to disable the email notification when exporting completed; defaults to true>,
}
```

```json
{
  "data": {
    "id": <string: unique id of this data export>,
    "status": <string: one of 'Pending…', 'Processing coding activity…', 'Uploading…', or 'Completed'>,
    "percent_complete": <float: percent of code stats that have been exported>,
    "download_url": <string: when completed, the url to download this data export>,
    "type": <string: either 'heartbeats' or 'daily'>,
    "is_processing": <boolean: whether this data export is currently processing in the background>,
    "is_stuck": <boolean: whether this data export is taking too long, probably due to an error>,
    "has_failed": <boolean: whether this data export failed to complete due to an error>,
    "expires": <string: datetime when this data export can no longer be downloaded>,
    "created_at": <string: datetime when this data export was requested>,
  },
}
```

--------------------------------

### WakaTime API Goal Response Example

Source: https://wakatime.com/developers

This JSON structure represents a typical response when querying WakaTime goals. It includes details about goal progress, configuration, and associated users.

```json
{
  "data": [
    {
      "average_status": <string: "fail" when there are more failure days or weeks than success, otherwise "success">
      "chart_data": [
        {
          "actual_seconds": <float: number of seconds coded during this delta period>,
          "actual_seconds_text": <string: human readable time coded during this delta period>,
          "goal_seconds": <integer: number of seconds required to meet goal for this delta period>,
          "goal_seconds_text": <string: human readable coding time required to meet goal for this delta period>,
          "range": {
            "date": <string: current time range as Date string in YEAR-MONTH-DAY format (only available when delta is "day")>,
            "end": <string: end of current time range as ISO 8601 UTC datetime>,
            "start": <string: start of current time range as ISO 8601 UTC datetime>,
            "text": <string: current range in human-readable format relative to the current day>,
            "timezone": <string: timezone used in Olson Country/Region format>
          },
          "range_status": <string: either "success", "fail", "pending", or "ignored">
          "range_status_reason": <string: an explanation for why this delta period passed or failed>
        }, …
      ],
      "created_at": <string: time when this goal was created in ISO 8601 format>,
      "cumulative_status": <string: status over all delta periods, either "success", "fail", or "ignored">
      "custom_title": <string: user defined custom title for this goal, overwrites goal title if defined>,
      "delta": <string: goal step duration; either "day" or "week">
      "editors": <list of strings: editors for this goal>,
      "id": <string: unique id of goal>,
      "ignore_days": <list of strings: goal status set to "ignored" instead of "failed" for these weekdsays, when delta is "day">
      "ignore_zero_days": <boolean: ignore days with no coding activity>,
      "improve_by_percent": <float: percent goal should increase each delta>,
      "is_current_user_owner": <boolean: whether the currently authenticated user is the owner of this goal>,
      "is_enabled": <boolean: whether this goal is enabled or disabled>,
      "is_inverse": <boolean: when true, the goal is to code less not more>,
      "is_snoozed": <boolean: goal email notifications are temporarily disabled until the date defined by snooze_until>,
      "is_tweeting": <boolean: this goal is setup to tweet progress each day>,
      "languages": <list of strings: languages for this goal>,
      "modified_at": <string: optional time when this goal was last changed in ISO 8601 format>,
      "owner": {
        "display_name": <string: display name of this user taken from full_name or @username. Defaults to 'Anonymous User'>,
        "email": <string: email address>,
        "full_name": <string: full name of user>,
        "id": <string: unique id of user>,
        "photo": <string: url of photo for this user>,
        "username": <string: user's public username>
      },
      "projects": <list of strings: projects for this goal>,
      "range_text": <string: complete range of this goal for all delta periods in human-readable format>,
      "seconds": <integer: goal amount>,
      "shared_with": [
        {
          "display_name": <string: display name of this user taken from full_name or @username. Defaults to 'Anonymous User'>,
          "email": <string: user's email, only defined if shared via email address>,
          "full_name": <string: full name of user>,
          "id": <string: unique id of user>,
          "photo": <string: url of photo for this user>,
          "status": <string: whether this invitation has been accepted or not by the other user>,
          "user_id": <string: user's id, only defined if shared via user id>,
          "username": <string: username, only defined if shared via username>
        }, …
      ],
      "snooze_until": <string: optional time when goal email notifications will be re-enabled, in ISO 8601 format>,
      "status": <string: most recent day or week range status; can be "success", "fail", "ignored", or "pending">
      "status_percent_calculated": <integer: for goals which are pre-calculated in the background, the percent completed until this goal's status will be available>,
      "subscribers": [
        {
          "email": <string: email address of this subscriber, if public>,
          "email_frequency": <string: how often this subscriber receives emails about this goal>,
          "full_name": <string: name of this subscriber, if public>,
          "user_id": <string: unique id of this subscriber>,
          "username": <string: username of this subscriber, if defined>
        }, …
      ],
      "title": <string: human readable title for this goal>,
      "type": <string: type of goal>
    }, …
  ],
  "total": <integer: number of goals>,
  "total_pages": <integer: number of pages>,
}

```

--------------------------------

### Example Response for Private Leaderboards

Source: https://wakatime.com/developers

This JSON structure represents the response when listing a user's private leaderboards. It includes details about each leaderboard and pagination information.

```json
{
  "data": [
    {
      "can_delete": true,
      "can_edit": true,
      "created_at": "2023-10-27T10:00:00Z",
      "has_available_seat": true,
      "id": "leaderboard-id-123",
      "members_count": 10,
      "members_with_timezones_count": 8,
      "modified_at": "2023-10-27T10:00:00Z",
      "name": "My Private Leaderboard",
      "time_range": "last_7_days"
    }
  ],
  "total": 1,
  "total_pages": 1
}
```

--------------------------------

### GET /api/v1/users/current/projects

Source: https://wakatime.com/developers

Retrieves a list of WakaTime projects for the currently authenticated user. Supports filtering by a search term.

```APIDOC
## GET /api/v1/users/current/projects

### Description
List of WakaTime projects for the current user.

### Method
GET

### Endpoint
/api/v1/users/current/projects

### Parameters
#### Query Parameters
- **q** (String) - Optional - Filter project names by a search term.

### Scope Required
read_stats.projects

### Response
#### Success Response (200)
- **data** (array) - List of projects. Each project object contains:
  - **id** (string) - unique project id
  - **name** (string) - project name
  - **repository** (string) - associated repository if connected
  - **badge** (string) - associated project badge if enabled
  - **color** (string) - custom project color as hex string, or null if using default color
  - **clients** (list) - clients associated with this project
  - **has_public_url** (boolean) - whether this project has a shareable url defined
  - **human_readable_last_heartbeat_at** (string) - time when project last received code stats as human readable string
  - **last_heartbeat_at** (string) - time when project last received code stats in ISO 8601 format
  - **human_readable_first_heartbeat_at** (string) - time when project first received code stats as human readable string; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC
  - **first_heartbeat_at** (string) - time when project first received code stats in ISO 8601 format; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC
  - **url** (string) - url of this project relative to wakatime.com
  - **urlencoded_name** (string) - project name url entity encoded
  - **created_at** (string) - time when project was created in ISO 8601 format

### Response Example
```json
{
  "data": [
    {
      "id": "<string: unique project id>",
      "name": "<string: project name>",
      "repository": "<string: associated repository if connected>",
      "badge": "<string: associated project badge if enabled>",
      "color": "<string: custom project color as hex string, or null if using default color>",
      "clients": <list: clients associated with this project>,
      "has_public_url": <boolean: whether this project has a shareable url defined>,
      "human_readable_last_heartbeat_at": "<string: time when project last received code stats as human readable string>",
      "last_heartbeat_at": "<string: time when project last received code stats in ISO 8601 format>",
      "human_readable_first_heartbeat_at": "<string: time when project first received code stats as human readable string; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC>",
      "first_heartbeat_at": "<string: time when project first received code stats in ISO 8601 format; currently only set for users who signed up after 2024-02-05T00:00:00Z UTC>",
      "url": "<string: url of this project relative to wakatime.com>",
      "urlencoded_name": "<string: project name url entity encoded>",
      "created_at": "<string: time when project was created in ISO 8601 format>"
    }
  ]
}
```
```