Skip to content
TTrackTimer
API documentation

Get today's personal summary

View Markdown

Read today's tracked time and earnings, including the running timer, in a chosen timezone.

GET /api/v1/summary

Required scope: timers:read

Returns only the API key user's time in its bound workspace. Historical entries remain included after project archival or assignment changes. Voided entries are excluded.

Request

Requires bearer authentication and the timers:read scope. No body. The required timezone query parameter is an IANA timezone such as America/New_York or UTC. Missing or invalid timezones return 400 INVALID_REQUEST.

GET https://www.tracktimer.app/api/v1/summary?timezone=America%2FNew_York

Send the Authorization header with Bearer YOUR_API_KEY. See authentication for key setup and errors and retries for shared errors and rate limits. This read is safe to retry.

Response — 200

{"trackedSeconds":5400,"earnings":[{"currency":"USD","amount":"75"}]}
  • trackedSeconds: nonnegative integer seconds from local midnight through the server's current time, including active timers. Entries spanning midnight contribute only their overlap with today. Day boundaries respect timezone and daylight saving changes.
  • earnings: totals grouped by currency, with amount as a decimal string retaining up to 12 fractional places. Pay uses each entry's snapshotted hourly pay rate, including nonbillable entries. These are calculated earnings, not invoiced or paid amounts. USD is currently the only supported currency.

An empty day returns {"trackedSeconds":0,"earnings":[]}. The running timer contributes only through the response's server time. Refresh once per minute for a menu bar display.