---
title: "Get ISP Metrics"
method: GET
path: "/v1/isp-metrics/{type}"
---

# Get ISP Metrics

`GET /v1/isp-metrics/{type}`

## Request

- Base URL: `https://api.ui.com`
- URL: `https://api.ui.com/v1/isp-metrics/{type}`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/docs/v1/isp-metrics/:type/get.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `type` string, required

## Query parameters

- `beginTimestamp` string
- `endTimestamp` string
- `duration` string

## Response `200`

200

- object
  - `data` object[]: Generic response data, specific schema depends on the endpoint
    - `metricType` string
    - `periods` object[]
      - `data` object
        - `wan` object
          - `avgLatency` integer
          - `download_kbps` integer
          - `downtime` integer
          - `ispAsn` string
          - `ispName` string
          - `maxLatency` integer
          - `packetLoss` integer
          - `upload_kbps` integer
          - `uptime` integer
      - `metricTime` string, date-time
      - `version` string
    - `hostId` string
    - `siteId` string
  - `httpStatusCode` integer: HTTP status code
  - `traceId` string: Request trace identifier

## Other responses

- `400`: 400
- `401`: 401
- `429`: 429
- `500`: 500
- `502`: 502

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-site-manager-api/revisions/16daa37f17c9?raw)
