searchSiteOspfStats
Search OSPF peer statistics for a site with filters for device, VRF, peer IP, and time range. Use Search Org OSPF Stats to search OSPF peer statistics across the organization.
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
Path Parameters
uuidQuery Parameters
Filter results by MAC address
Filter peer results by VRF name
Filter peer results by peer IP address
Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w
Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now
Maximum number of results to return per page
0 <= value100On which field the list should be sorted, -prefix represents DESC order
"timestamp"Pagination cursor for retrieving subsequent pages of results. This value is automatically populated by Mist in the next URL from the previous response and should not be manually constructed.
Response Body
curl -X GET "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/stats/ospf_peers/search"{ "end": 1711035686, "limit": 10, "next": "string", "results": [ { "dead_time": 0, "mac": "string", "neighbor": "172.29.1.4", "neighbor_id": "172.16.254.2", "org_id": "a97c1b22-a4e9-411e-9bfd-d8695a0f9e61", "peer_ip": "string", "port_id": "string", "priority": 0, "site_id": "441a1214-6928-442a-8e92-e1d34b8ec6a6", "state": "string", "timestamp": 0.1, "up": true, "vrf_name": "string" } ], "start": 1710949286, "total": 232}countOrgOspfStats GET
Count OSPF peer statistics for a site, optionally grouped by the `distinct` field and filtered by time range. Use [Count Org OSPF Stats](/api/mist/orgs/orgs-stats/orgs-stats---ospf/countOrgOspfStats) to count OSPF peer statistics across the organization.
countSiteSwOrGwPorts GET
Count switch and gateway port statistics for a site, optionally grouped by the `distinct` field and filtered by port, neighbor, PoE, STP, traffic, and time attributes. Use [Count Org Switch/Gateway Ports](/api/mist/orgs/orgs-stats/orgs-stats---ports/countOrgSwOrGwPorts) to count switch and gateway port statistics across the organization.