Skip to main content
GET
WrenchMode per-technician analytics

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Path Parameters

fromDate
string
required

Window start, yyyy-MM-dd. The rollup starts at the beginning of this day, in the timezone zone or UTC when timezone is omitted.

toDate
string
required

Window end, yyyy-MM-dd, inclusive of the whole day in the timezone zone or UTC when timezone is omitted. At most 1 month after fromDate; the cap is checked on the dates as given.

Query Parameters

supervisorEmail
string

Optional: restrict the rollup to technicians under this supervisor

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that fromDate and toDate are read in. fromDate starts at the beginning of that day in the zone, and toDate includes that whole day in the zone. The zone's real day boundaries apply, so a daylight saving change day is 23 or 25 hours long. When omitted, dates are UTC days. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400.

Example:

"America/Chicago"

Response

Successful response

type
string
required

Entity type label, e.g. "WrenchHubUserAnalytics". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object[]
required
count
integer<int64>
required

Total number of matching records (across all pages)

status
enum<string>
required

"ok" on success

Available options:
ok