Dashboard widgets and reportsGet my vacation balance (Insights widget)

Get my vacation balance (Insights widget)

Insights endpoint vacation-calculation-widget-data. Help text: 'The vacation balance is your current status of days available for vacation. The end of month vacation balance, is calculated by taking the current balance, adding the accrued vacation, and subtracting taken and planned vacation. Vacation, Additional Vacation Days). Unit: days, as the help text states. Presented as the caller's OWN balance; the frontend sends no query parameter and the consumer declares no employee selector. PASS-THROUGH PROXY. Insights' HTTP status, headers and body are returned to the caller unchanged. The controller says it exists only so the React frontend can reach Insights and must not be used for anything else.

Use it to:

  • Show an employee their projected vacation balance month by month

Not for:

  • Vacation / absence accounting or payroll export — use the absence and vacation APIs
  • Anything outside the front-page widget (controller comment)

Behaviour:

  • Read-after-write consistency: not yet documented.

Not yet documented: behaviour; examples; purpose → description; response → default ordering; response → empty result; response → pagination; response → success.

curl -X GET "https://app3.timelog.com/your-account/api/v2/insights-service/vacation-calculation" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "type": "example_string",
    "width": 3.14,
    "height": 3.14,
    "sortOrder": 3.14,
    "data": {
      "previousMonthTotals": {},
      "assignedVacations": {},
      "absences": {},
      "availableTimeOff": {},
      "previousMonthTotalsDetails": {},
      "assignedVacationsDetails": {},
      "absencesDetails": {},
      "availableTimeOffDetails": {}
    }
  },
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ],
  "Actions": [
    {}
  ]
}
GET
/v2/insights-service/vacation-calculation
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Responses

Propertiesobject

Vacation balance widget for the CALLER (help text: 'your current status of days available for vacation'). Not paged; data is one object of month-keyed rows. CONSUMER-DECLARED SHAPE. Meanings come from the frontend's use and the product's widget help text, not from the producer.

Not yet documented: source type.

Linksarray
Actionsobject[]