Get Service Time Report

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

Estimated vs actual time per service: total minutes logged in the window attributed to services via each entry's linked task, compared against the summed estimates of those tasks. Drill down with serviceCode (rows per client), serviceCode + clientCode (rows per task) and taskCode (rows per workflow step); below the service level a catch-all row makes the rows add up to the row drilled from, and the summary covers the drilled scope. groupBy=TeamMember gives one row per person instead (narrow it with serviceCode): time by who logged it, estimates by the step's (or task's) assignee. Requires time tracking to be in use.

Requires: ViewAll on Reports.

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 Last30Days). If CustomDateRange, startDate and endDate are required.

Preset date range for the time entry window (default Last30Days). 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

serviceCode query string

Drill into one service - rows group by client instead of by service. With groupBy=TeamMember, narrows the team member view to the service

Drill into one service - rows group by client instead of by service. With groupBy=TeamMember, narrows the team member view to the service

clientCode query string

With serviceCode, drill into one client - rows group by task

With serviceCode, drill into one client - rows group by task

taskCode query string

Drill into one task - rows group by workflow step. Not combined with serviceCode or clientCode

Drill into one task - rows group by workflow step. Not combined with serviceCode or clientCode

groupBy query string

Breakdown dimension: Service (default, drillable) or TeamMember (optionally filtered by serviceCode; no clientCode or taskCode)

Breakdown dimension: Service (default, drillable) or TeamMember (optionally filtered by serviceCode; no clientCode or taskCode)

Responses

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