getSiteInsightMetrics

Get Site Insight Metrics

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

An API token generated for a specific admin has the same privileges as that admin
An API token is automatically removed if it is not used for more than 90 days
SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

site_id*string

Formatuuid

metrics*string

Comma separated Metric names, e.g. num_clients,num_aps. See possible values at List Insight Metrics

start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"

interval?string

Aggregation works by giving a time range plus interval (e.g. 1d, 1h, 10m) where aggregation function would be applied to.

limit?integer

Maximum number of results to return per page

Range0 <= value

Default100

page?integer

Select the page number to return when using page-based pagination; starts at 1

Range1 <= value

Default1

curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/insights?metrics=num_clients%2Cnum_aps"

{  "end": 0,  "interval": 0,  "results": [    {}  ],  "start": 0}