Guard ranking
patroltech_patrollers_get_rankingUse when you want to compare guards by rounds completed and scans over a period, instead of building the comparison yourself. Returns the guards ordered by their activity in the period (rounds completed, completion rate, scans), each with totalScans, roundsCompleted, completionRate (percent of the checkpoints scanned out of all the checkpoints of the rounds of the guard; not the share of rounds completed) and avgTimeBetweenScans (seconds; null without data), plus a team summary and the most scanned checkpoints (topCheckpoints). Dates are calendar days in the time zone of the account; without a period it covers everything the data retention allows. retentionCutoff (UTC; null when unlimited): the period never starts before it, so older activity is not counted. With truncated: true the list is capped. It is activity data, not an assessment of the people (it does not see shifts, absences or assigned tasks): present it with its period and do not draw conclusions from it on your own about the performance or employment of anyone. Do not use when you need the people who sign in to the dashboard.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "patroltech_patrollers_get_ranking"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End date of the range (inclusive), YYYY-MM-DD. | |
| from | No | Start date of the range, YYYY-MM-DD (never words like "yesterday"). | |
| period | No | Relative period. Use it when the user says "today", "yesterday", "last week", "last month" or similar. | |
| organization | No | Omit unless the account has more than one organization; then the exact name (or id) as listed by patroltech_account_get_context. |