Mist Sites Stats - Devices API
API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
Mist Sites Stats - Devices API is one of 212 APIs that Mist publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sites Stats - Devices. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 5 operations across 5 paths, and defines 186 schemas. It is described by OpenAPI 3.2.0, at version 2606.1.1.
Requests are made against 12 base URLs: https://api.mist.com, https://api.gc1.mist.com, https://api.ac2.mist.com, https://api.gc2.mist.com, https://api.gc4.mist.com, https://api.eu.mist.com, https://api.gc3.mist.com, https://api.ac6.mist.com, https://api.gc6.mist.com, https://api.ac5.mist.com, https://api.gc5.mist.com, https://api.gc7.mist.com.
5 operations
5 paths
186 schemas
5 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Mist Sites Stats - Devices API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (apiToken).
An API key is passed in the header as X-CSRFToken (csrfToken).
By default, every request must be authenticated.
apiToken— Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header. Format: Authorization: Token {apitoken} N…csrfToken— Session-based authentication for browser or login/password flows. After a successful [Login](/operations/login) request, Mist returns a csrftoken cookie. Send…
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.
Sites Stats - Devices 5
API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Site level
GET
/api/v1/sites/{site_id}/stats/devices
listSiteDevicesStats
GET
/api/v1/sites/{site_id}/stats/devices/{device_id}
getSiteDeviceStats
GET
/api/v1/sites/{site_id}/stats/devices/{device_id}/clients
getSiteAllClientsStatsByDevice
GET
/api/v1/sites/{site_id}/stats/gateways/metrics
getSiteGatewayMetrics
GET
/api/v1/sites/{site_id}/stats/switches/metrics
getSiteSwitchesMetrics
Schemas 186
The contract defines 186 schemas that model the data the API accepts and returns. The most detailed are stats_ap (70 properties), stats_gateway (61 properties), stats_wireless_client (57 properties), stats_switch_port (50 properties). Each schema is shown below with its type and property counts.
port_auth_state
string
Port authentication state. enum: "", authenticated, authenticating, held, init
stats_ap_gps_stat
object
GPS location data reported by an AP
6 properties
route_summary_stats
object
Route table capacity and usage summary
4 properties
wan_tunnel_protocol
string
Tunnel protocol used for the connection. enum: gre, ipsec
org_id
string
Unique identifier of a Mist organization
stats_gateway_service_status
object
Gateway security service installation and runtime status
10 properties
module_stat_item_poe
object
Power over Ethernet telemetry for a device module
3 properties
tx_bps
integernull
Rate of transmitting traffic, bits/seconds, last known
rx_bps
integernull
Rate of receiving traffic, bits/seconds, last known
ap_stat_mesh_downlink
object
Runtime statistics for a mesh downlink from this AP
18 properties
module_stat_item_vc_links_item
object
Virtual chassis link endpoint for a device module
3 properties
ap_radio_stat
object
Runtime radio statistics for an access point radio
20 properties
tx_rate
numbernull
Transmit data rate reported for a wireless or mesh link, in Mbps
gateway_compliance_version
object
Version compliance metric for gateway devices
3 properties
bgp_peer
object
Only present when bgppeers in fields query parameter
16 properties
stats_gateway_module_stat_item
object
Hardware module status and firmware inventory for a gateway
31 properties
strings
array
Unique string values returned or accepted by this schema
stats_devices
array
Device statistics records returned by a stats response
response_switch_metrics_config_success_details
object
Detail values for the switch configuration success metric
1 property
last_seen
numbernull
Timestamp indicating when the entity was last seen
stats_cluster_config_ethernet_connection_item
object
Ethernet interface connection state for a gateway cluster member
2 properties
stats_switch_module_stat_item
object
Hardware module status and firmware inventory for a switch
35 properties
stats_wireless_client_wxrule_usages
array
Current WxLAN rule usage counters keyed by wireless tag
stats_ap_auto_placement_info
object
Additional diagnostics for AP auto placement
3 properties
port_stp_state
string
Spanning Tree Protocol state for the port. enum: "", blocking, disabled, forwarding, learning, listening
stats_ap_switch_redundancy
object
Switch redundancy status reported by an AP
1 property
module_stat_item_errors
array
Used to report all error states the device node is running into. An error should always have type and since fields, and could have some other fields specific t…
tx_retries
integernull
Amount of tx retries
stats_switch_ports
array
Switch port statistics records returned by a stats response
stats_switch_ap_redundancy
object
AP switch redundancy coverage summary for a switch
3 properties
arp_table_stats
object
ARP table usage and capacity statistics
2 properties
guest
object
Guest authorization record at site scope
18 properties
stats_switch_clients_stats_total_total_num_aps
array
AP count values included in the aggregate switch client statistics
stats_wireless_client_rssi_zone
object
RSSI zone currently containing a wireless client
2 properties
if_stat_property_servp_info
object
Service-provider and geolocation details associated with an interface address
7 properties
stats_wireless_client_zone
object
Zone currently containing a wireless client
2 properties
stat_device_status_filter
string
enum: all, connected, disconnected
module_stat_item_psus
array
Power supply status records for a device module
gateway_compliance_major_version_properties
object
Version-compliance details for one gateway model
2 properties
stats_ap_usb_stat
object
USB peripheral status reported by an AP
5 properties
module_stat_item_vc_links
array
Virtual chassis link records for a device module
stats_wireless_client_airwatch
object
AirWatch authorization information reported for a wireless client
1 property
1 required
rx_bytes
integernull
Amount of traffic received since connection
stats_wireless_client_wxrule_usage
object
WxLAN rule usage counter for one wireless tag
2 properties
ip_type6
string
enum: autoconf, dhcp, disabled, static
module_stat_item_pics_item
object
Physical Interface Card summary for a device module
3 properties
fwupdate_stat_status
stringnull
enum: inprogress, failed, upgraded, success, scheduled, error
stats_gateway_vpn_peers
array
Only present when vpnpeers in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/vpnpeers/search result object, except that o…
dot11_band
string
enum: 24, 5, 5-dedicated, 5-selectable, 6, 6-dedicated, 6-selectable
response_http403
object
Standard HTTP 403 permission error response
1 property
stats_gateway_wan_tunnels
array
Only present when tunnels in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/tunnels/search result object, except that org…
stats_gateway_mac_table_stats
object
Gateway MAC table utilization counters
2 properties
ibeacon_minor
integernull
Minor number for iBeacon
memory_stat
object
Memory utilization statistics for a device; in a virtual chassis, this reports the master Routing Engine
1 property
1 required
ibeacon_major
integernull
Major number for iBeacon
module_stat_item_pics_item_port_groups_item
object
Port group summary for a PIC
2 properties
stats_ap_lldp_stat
object
LLDP neighbor information and power negotiations. For backward compatibility, when multiple neighbors exist, only information from the first neighbor is displa…
19 properties
tx_bytes
integernull
Amount of traffic sent since connection
l2tp_state
string
enum: established, establishedwithsession, idle, wait-ctrl-conn, wait-ctrl-reply
stats_switch_clients_stats
object
Aggregate switch client counts
1 property
switch_metric_scope
string
Scope level used when querying switch metrics. enum: site, switch
bgp_stats_state
string
enum: active, connect, established, idle, openconfig, opensent
stats_gateway_ports
array
Only present when ports in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/ports/search result object, except that orgid,…
ap_redundancy_modules
object
Property key is the node id
module_stat_item_pics
array
Physical Interface Card summaries for a device module
stats_ap_lldp_stats
object
Property key is the port name (e.g. "eth0", "eth1", ...). Map of ethernet ports to their respective LLDP neighbor information and power negotiations. Only pres…
ibeacon_uuid
stringnull
iBeacon UUID value, or null when no iBeacon UUID is configured
response_switch_metrics_active_ports_summary
object
Active-port summary metric for switches in the requested scope
3 properties
stats_cluster_config
object
High-availability cluster configuration and health reported by a gateway
10 properties
stats_ap_port_stat
object
Ethernet port statistics reported by an AP
10 properties
if_stat
object
Property key is the interface name
module_stat_item_temperatures_item
object
Temperature sensor reading for a device module
3 properties
ap_ip_config_dns
array
If type==static. DNS server IP addresses for AP management traffic
last_trouble
object
Last trouble indicator reported by a switch
2 properties
stats_ap_esl_stat
objectnull
Electronic shelf label dongle status reported by an AP
8 properties
stats_ap_ble
object
BLE beacon and traffic statistics reported by an AP
23 properties
stats_cluster_config_ethernet_connection
array
Ethernet interface connection states for a gateway cluster
ip_type
string
IP address assignment mode, either DHCP or static. enum: dhcp, static
created_time
number
When the object has been created, in epoch
stats_ap_auto_placement_info_probability_surface
object
Circular uncertainty area for an AP auto placement result
3 properties
integers
array
List of integer values
stats_wireless_client_vbeacons
array
Virtual beacon associations for the wireless client, including when each began
dhcpd_stat
object
Property key is the network name
stats_ap_l2tp_stat_session
object
L2TP tunnel session reported by an AP
4 properties
stats_cluster_config_fabric_link_info
object
Fabric link status details for a gateway cluster
5 properties
mac_table_stats
object
MAC table capacity and usage statistics
2 properties
stats_ap_auto_placement
object
Auto placement result and status for an AP
8 properties
stats_ap_radio_config_band
object
Per-band radio configuration reported by an AP
10 properties
dhcpd_stat_lan
object
DHCP lease statistics for one network
2 properties
response_switch_metrics_config_success
object
Configuration success metric for switches in the requested scope
3 properties
stats_ap_radio_stat
object
Per-band radio statistics reported by an AP
3 properties
stats_switch_port_type
string
device type. enum: ap, ble, gateway, mxedge, nac, switch
bgp_as
BGP AS, value in range 1-4294967294. Can be a Variable (e.g. {{bgpas}} )
ip_stat
object
Read-only IP addressing status reported by a device interface
10 properties
stats_ap_iot_stat
object
IoT input statistics reported by an AP
stats_ap_iot_stat_additional_properties
object
IoT input statistic value
1 property
module_stat_item_fans
array
Cooling fan status records for a device module
stats_ap_lldp_stat_power_src
string
Single power source (DC Input / PoE 802.3at / PoE 802.3af / PoE 802.3bt / MULTI-PD / LLDP / ? (unknown)).
stats_wireless_clients
array
Wireless client statistics records returned by a stats response
stats_wireless_client_rssi_zones
array
RSSI zone memberships for the wireless client, including when each membership began
fwupdate_stat
object
Firmware update status for a device
5 properties
ap_ip_config
object
Management IP addressing settings for an access point
12 properties
stats_wireless_client
object
Wireless client connection, traffic, and location statistics
57 properties
12 required
stats_ap_l2tp_stat
object
L2TP tunnel status reported by an AP
4 properties
stats_switch_ap_redundancy_module
object
AP switch redundancy counts for one VC or stack member
2 properties
stats_cluster_config_redundancy_group_info
array
Redundancy group monitoring entries for a gateway cluster
stats_ap_env_stat
object
Device environment, including CPU temperature, Ambient temperature, Humidity, Attitude, Pressure, Accelerometers, Magnetometers and vCore Voltage
12 properties
rx_pkts
integernull
Amount of packets received since connection
module_stat_item_fans_items
object
Cooling fan telemetry for a device module
4 properties
ap_led
object
Indicator light settings for an access point
2 properties
timestamp
number
Epoch timestamp, in seconds
stats_switch
object
Switch statistics reported by Mist for a site or organization stats response
48 properties
1 required
response_switch_metrics_version_compliance
object
Version compliance metric for switches in the requested scope
3 properties
ap_stat_mesh_uplink
object
Runtime statistics for this AP's mesh uplink
19 properties
stats_wireless_client_zones
array
Zone memberships for the wireless client, including when each membership began
ap_ip_config_dns_suffix
array
Required if type==static; DNS search suffixes applied to AP management lookups
switch_metrics_active_ports_summary_details
object
Port counts used by the active-port switch metric
2 properties
bgp_peers
array
Only present when bgppeers in fields query parameter. Each port object is same as GET /api/v1/sites/{siteid}/stats/bgppeers/search result object, except that o…
response_http429
object
Standard HTTP 429 rate limit error response
1 property
stats_switch_port_poe_mode
string
enum: 802.3af, 802.3at, 802.3bt
response_http401
object
Standard HTTP 401 authentication error response
1 property
switch_metrics_compliance_major_version
object
Version compliance grouping for one switch model
4 properties
stats_cluster_config_redundancy_group_info_item
object
Redundancy group monitoring entry for a gateway cluster
3 properties
stats_ap_lldp_stat_mgmt_addrs
array
Management IP addresses advertised by an LLDP neighbor
stats_ap_auto_upgrade
object
Auto-upgrade status for an AP
1 property
id
string
Unique ID of the object instance in the Mist Organization
response_switch_metrics
object
Switch metrics returned for the requested site or switch scope
3 properties
stats_ap_gps_stat_src
string
The origin of the GPS data. enum: gps: from this device GPS estimates, otherap from neighboring device GPS estimates. Note: API responses may return otheraps w…
module_stat_item_psus_item
object
Power supply status for a device module
2 properties
dot11_bandwidth
integer
channel width for the band.enum: 0(disabled, response only), 20, 40, 80 (only applicable for band5 and band6), 160 (only for band6)
device_type_with_all
string
ap, switch, gateway, router, all, default is ap. Supports comma-separated values for multiple types (e.g., type=switch,gateway)
stats_cluster_config_control_link_info
object
Control link status details for a gateway cluster
2 properties
tunnel_priority
string
Relative preference assigned to the tunnel. enum: primary, secondary
module_stat_item_pics_item_port_groups
array
Port group summaries for a PIC
module_stat_item_network_resources
array
Network resource usage counters reported by a device module
stats_gateway_module_stat
array
Hardware module statistics reported by a gateway
gateway_metrics
object
Gateway metric scores returned by the site gateway metrics API
2 properties
stats_wireless_client_vbeacon
object
Virtual beacon currently associated with a wireless client
2 properties
rx_rate
numbernull
Receive data rate reported for a wireless or mesh link, in Mbps
stats_ap
object
AP runtime statistics, placement data, and inventory metadata
70 properties
1 required
switch_metrics_compliance_major_versions
array
Software version compliance groupings by switch model and version
ap_redundancy
object
AP switch redundancy coverage summary
3 properties
device_type_switch
string
Device Type. enum: switch
response_http400
object
Standard HTTP 400 bad request error response
1 property
rx_retries
integernull
Amount of rx retries
stats_switch_port
object
Switch port statistics record returned by stats APIs
50 properties
4 required
stats_gateway_spu_item
object
Services Processing Unit resource and session counters
7 properties
service_stat
object
Service version information keyed by service name
stats_ap_lldp_stat_power_srcs
array
Power sources reported through LLDP for an AP
dot11_proto
string
enum: a, ac, ax, b, be, g, n
module_stat_item_errors_items
object
Error condition reported for a device module
5 properties
2 required
stats_gateway_vpn_peer
object
VPN peer path statistics reported by a gateway
16 properties
module_stat_item_network_resource
object
Network resource usage counter reported by a device module
3 properties
stats_ap_l2tp_stat_sessions
array
L2TP tunnel sessions reported by an AP
stats_gateway_wan_tunnel
object
WAN tunnel statistics reported by a gateway
19 properties
modified_time
number
When the object has been modified for the last time, in epoch
stats_switch_clients
array
Clients observed on switch ports in switch statistics
antenna_select
string
Antenna Mode for AP which supports selectable antennas. enum: "" (default), external, internal
stats_switch_module_stat
array
Hardware module statistics reported by a switch
gateway_compliance_major_version
object
Gateway version-compliance entries keyed by gateway model
const_device_type_ap
string
Device Type. enum: ap
cpu_stat_load_avg
array
Load averages for the last 1, 5, and 15 minutes
if_stat_property
object
Interface statistics and metadata reported by a device
16 properties
stats_gateway
object
Gateway statistics reported by Mist for a site or organization stats response
61 properties
2 required
const_device_type_gateway
string
Device Type. enum: gateway
tx_pkts
integernull
Amount of packets sent since connection
ip_stat_ips
stringnull
Property key is the VLAN name
response_http404
object
Standard HTTP 404 not found error response
1 property
service_stat_property
object
Version information for gateway service packages
8 properties
stats_ap_expiring_certs
object
Map of certificate serial numbers to their expiry timestamps (in epoch) for certificates expiring within 30 days. Property key is the certificate serial number
stats_ap_radio_config
object
Radio configuration reported by an AP
5 properties
ap_redundancy_module
object
AP switch redundancy counts for one VC member
2 properties
stats_gateway_port
object
Gateway port statistics record returned by stats APIs
44 properties
3 required
stats_switch_client_item
object
Client observed on a switch port in switch statistics
4 properties
site_id
string
Unique identifier of a Mist site
response_switch_metrics_version_compliance_details
object
Detail values for the switch software version compliance metric
1 property
port_stp_role
string
Spanning Tree Protocol role for the port. enum: "", alternate, backup, designated, disabled, root, root-prevented
switch_metric_type
string
Switch metric type requested for active port summaries. enum: activeportssummary
stats_switch_clients_stats_total
object
Total AP and wired-client counts for switch client statistics
2 properties
module_stat_item_temperatures
array
Temperature sensor readings for a device module
poe_priority
string
PoE priority. enum: low, high
stats_device
Device statistics record for an AP, switch, or gateway
stats_gateway_spu
array
Services Processing Unit statistics reported by a gateway
stats_switch_vc_setup_info
object
Virtual Chassis setup request and status details reported by a switch
6 properties
stats_gateway_cluster
object
High-availability cluster state reported by a gateway
1 property
cpu_stat
object
CPU utilization breakdown for a device
6 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Mist 12
Other APIs Mist publishes across the network.
Mist Admins API
Mist Admins Login API
Mist Admins Login - OAuth2 API
Mist Admins Logout API
Mist Admins Lookup API
Mist Admins Recover Password API
Mist Constants Definitions API
Mist Constants Events API
Mist Constants Models API
Mist Installer API
Mist MSPs Admins API
Mist MSPs API
#Sites Stats - Devices
Where this information came from
This is an independent, third-party profile of Mist Sites Stats - Devices API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.