2021-12-11 08:31:58 -08:00
|
|
|
---
|
|
|
|
|
id: wakatime
|
|
|
|
|
title: Wakatime
|
|
|
|
|
sidebar_label: Wakatime
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## What
|
|
|
|
|
|
|
|
|
|
Shows the tracked time on [wakatime][wt] of the current day
|
|
|
|
|
|
|
|
|
|
:::caution
|
|
|
|
|
|
|
|
|
|
You **must** request an API key at the [wakatime][wt] website.
|
|
|
|
|
The free tier for is sufficient. You'll find the API key in your profile settings page.
|
|
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
## Sample Configuration
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"type": "wakatime",
|
|
|
|
|
"style": "powerline",
|
|
|
|
|
"powerline_symbol": "\uE0B0",
|
|
|
|
|
"foreground": "#ffffff",
|
|
|
|
|
"background": "#007acc",
|
|
|
|
|
"properties": {
|
|
|
|
|
"url": "https://wakatime.com/api/v1/users/current/summaries?start=today&end=today&api_key=API_KEY",
|
|
|
|
|
"cache_timeout": 10,
|
|
|
|
|
"http_timeout": 500
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
|
|
|
|
- url: `string` - Your Wakatime [summaries][wk-summaries] URL, including the API key. Example above. You'll know this
|
|
|
|
|
works if you can curl it yourself and a result. - defaults to ``
|
|
|
|
|
- http_timeout: `int` - The default timeout for http request is 20ms. If no segment is shown, try increasing this timeout.
|
|
|
|
|
- cache_timeout: `int` - The default timeout for request caching is 10m. A value of 0 disables the cache.
|
|
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
## Template ([info][templates])
|
|
|
|
|
|
|
|
|
|
:::note default template
|
|
|
|
|
|
|
|
|
|
``` template
|
|
|
|
|
{{ secondsRound .CummulativeTotal.Seconds }}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
### Properties
|
2021-12-11 08:31:58 -08:00
|
|
|
|
|
|
|
|
- `.CummulativeTotal`: `wtTotals` - object holding total tracked time values
|
|
|
|
|
|
2022-02-01 03:10:46 -08:00
|
|
|
### wtTotals Properties
|
2021-12-11 08:31:58 -08:00
|
|
|
|
|
|
|
|
- `.Seconds`: `int` - a number reprecenting the total tracked time in seconds
|
|
|
|
|
- `.Text`: `string` - a string with human readable tracked time (eg: "2 hrs 30 mins")
|
|
|
|
|
|
|
|
|
|
[wt]: https://wakatime.com
|
|
|
|
|
[wk-summaries]: https://wakatime.com/developers#summaries
|
2022-04-20 09:43:59 -07:00
|
|
|
[templates]: /docs/configuration/templates
|
