Get ISP Metrics
Retrieves ISP metrics data for all sites linked to the UI account's API key. 5-minute interval metrics are available for at least 24 hours, and 1-hour interval metrics are available for at least 30 days.
get/v1/isp-metrics/{type}
Request
- Base URLhttps://api.ui.com
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
typestring required
Specifies whether metrics are returned using 5m or 1h intervals
Query parameters
beginTimestampstring
The earliest timestamp to retrieve data from (RFC3339 format)
endTimestampstring
The latest timestamp to retrieve data up to (RFC3339 format)
durationstring
Specifies the time range of metrics to retrieve, starting from when the request is made. Supports 24h for 5-minute metrics, and 7d or 30d for 1-hour metrics. This parameter cannot be used with beginTimestamp or endTimestamp.
Response
200
Changes
No recorded changes to this operation across all 2 revisions of this API.