getPastClientNum
Get historical client count trend for a time range to analyze how connected device numbers changed.
Instructions
Get historical client count trend over a time range. Returns a time-series of client counts to show how connected devices changed over the specified period. Requires start and end as Unix epoch seconds.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"start": "<start>",
"end": "<end>"
},
"name": "getPastClientNum"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | Yes | End of the time range as Unix epoch seconds. | |
| start | Yes | Start of the time range as Unix epoch seconds. | |
| siteId | No | Site ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs. | |
| customHeaders | No | Optional HTTP headers to include in the Omada API request (e.g. {"X-Custom-Header": "value"}). Rarely needed. |