Get work time stats for a user for a given date range and for today.

Stats will include:

  • start date
  • end date
  • total actual (logged) work time, in minutes
  • total billable time, in minutes
  • utilization rate, 0–100.0
  • work time balance, in minutes

Permissions. User's work time balance can be accessed by:

  • user themselves
  • user's approvers
  • company's managers and accountants

Examples

{
  "stats": {
    "start_date": "2025-03-25",
    "end_date": "2025-06-03",
    "actual_worked_time": 2220,
    "billable_time": 1740,
    "utilization": 78.38,
    "work_time_balance": -16500
  },
  "today_stats": {
    "start_date": "2025-06-04",
    "end_date": "2025-06-04",
    "actual_worked_time": 0,
    "billable_time": 0,
    "utilization": null,
    "work_time_balance": -480
  }
}

Params

Param name Description
user_id
optional

User ID. Default: current user ID.

Validations:

  • Must be a Integer

start_date
optional

Date to start the balance calculations from. Default: date of the user’s first time entry. If start date has not been passed explicitly and user has no time entries, time balance will not be calculated.

Validations:

  • Must be a String

end_date
optional

Date to end the balance calculations with, inclusive. Default: yesterday.

Validations:

  • Must be a String

date_range
optional

Get stats within the specified date range.Either pass date_range or start/end dates. Date range format: "DD/MM/YYYY - DD/MM/YYYY" (e.g. 15/02/2025 - 28/02/2025).

Validations:

  • Must be a String