API Docs / Operations / Reports / Get Team Time Report

Get Team Time Report

GET /tenants/{tenant}/reports/team-time

Hours logged per team member over the window against the hours they were expected to log, so under-logging and over-logging both stand out without checking person by person. Members who logged nothing still get a row. Expectations come from each member's expected week (or the practice standard), pro-rated across working days and capped at today when the window runs past it. Short windows also carry a per-day breakdown, and every window carries each member's split by task category. Pass teamCode to narrow to one team, or categoryCode to narrow every figure to one task category (which drops the expectation, since a working pattern covers all work rather than one category's). Requires time tracking to be in use.

Parameters

NameTypeDescription
tenant* path string

The Tenant.Code

The Tenant.Code

offset query integer (int32)

Number of records to skip (default: 0). Use with limit for pagination.

Number of records to skip (default: 0). Use with limit for pagination.

limit query integer (int32)

Maximum number of records to return (default: 10, max: 50)

Maximum number of records to return (default: 10, max: 50)

dateRange query string

Preset date range for the time entry window (default ThisWeek). If CustomDateRange, startDate and endDate are required.

Preset date range for the time entry window (default ThisWeek). If CustomDateRange, startDate and endDate are required.

startDate query string

Entry window start (inclusive). Only valid when dateRange=CustomDateRange

Entry window start (inclusive). Only valid when dateRange=CustomDateRange

endDate query string

Entry window end (inclusive). Only valid when dateRange=CustomDateRange

Entry window end (inclusive). Only valid when dateRange=CustomDateRange

teamCode query string

Limit the rows to the members of one team

Limit the rows to the members of one team

categoryCode query string

Limit the figures to time logged against tasks in one task category

Limit the figures to time logged against tasks in one task category

Responses

400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden