API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Org level By default, the API call only returns a subset of the available fields. Additional fields can be requested by adding the query parameter `fields=` and the list of fields, or `fields=*` to retrieve all the available fields.
openapi: 3.1.0
info:
contact:
email: tmunzer@juniper.net
name: Thomas Munzer
description: '> Version: **2606.1.1**
>
> Date: **July 10, 2026**
<div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>
---
## Additional Documentation
* [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)
* [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)
* [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)
## Helpful Resources
* [API Sandbox and Exercises](https://api-class.mist.com/)
* [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)
* [Python Script Examples](https://github.com/tmunzer/mist_library)
* [API Demo Apps](https://apps.mist-lab.fr/)
* [Juniper Blog](https://blogs.juniper.net/)
## Mist Web Browser Extension:
* Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)
* Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)
---'
license:
name: MIT
url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
title: Mist Admins Orgs Stats - Devices API
version: 2606.1.1
x-logo:
altText: Juniper-MistAI
backgroundColor: '#FFFFFF'
url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
url: https://api.mist.com
- description: Mist Global 02
url: https://api.gc1.mist.com
- description: Mist Global 03
url: https://api.ac2.mist.com
- description: Mist Global 04
url: https://api.gc2.mist.com
- description: Mist Global 05
url: https://api.gc4.mist.com
- description: Mist EMEA 01
url: https://api.eu.mist.com
- description: Mist EMEA 02
url: https://api.gc3.mist.com
- description: Mist EMEA 03
url: https://api.ac6.mist.com
- description: Mist EMEA 04
url: https://api.gc6.mist.com
- description: Mist APAC 01
url: https://api.ac5.mist.com
- description: Mist APAC 02
url: https://api.gc5.mist.com
- description: Mist APAC 03
url: https://api.gc7.mist.com
security:
- apiToken: []
- csrfToken: []
tags:
- description: 'API Calls to retrieve statistics about the Mist Managed and Monitored Devices at the Org level
By default, the API call only returns a subset of the available fields. Additional fields can be requested by adding the query parameter `fields=` and the list of fields, or `fields=*` to retrieve all the available fields.'
name: Orgs Stats - Devices
paths:
/api/v1/orgs/{org_id}/stats/devices:
parameters:
- $ref: '#/components/parameters/org_id'
get:
description: 'Get List of Org Devices stats
This API renders some high-level device stats, pagination is assumed and returned in response header (as the response is an array)'
operationId: listOrgDevicesStats
parameters:
- description: 'Filter results by one device type. Use a single value; comma-separated values are not supported. enum: `all`, `ap`, `gateway`, `switch`'
in: query
name: type
schema:
$ref: '#/components/schemas/device_enum_with_all'
- description: 'Filter results by status. enum: `all`, `connected`, `disconnected`. Accepts multiple comma-separated values.'
example: disconnected,connected
in: query
name: status
schema:
type: string
- description: Filter results by site identifier. Accepts multiple comma-separated values.
in: query
name: site_id
schema:
examples:
- 00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002
type: string
- description: Filter results by MAC address. Accepts multiple comma-separated values.
in: query
name: mac
schema:
examples:
- 5c5b53010101,5c5b53020202
type: string
- description: Filter results by evpntopo id
in: query
name: evpntopo_id
schema:
type: string
- description: If `evpn_unused`==`true`, find EVPN eligible switches which don’t belong to any EVPN Topology yet
in: query
name: evpn_unused
schema:
type: string
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/page'
responses:
'200':
$ref: '#/components/responses/DevicesArrayStatsOrg'
'400':
$ref: '#/components/responses/HTTP400'
'401':
$ref: '#/components/responses/HTTP401'
'403':
$ref: '#/components/responses/HTTP403'
'404':
$ref: '#/components/responses/HTTP404'
'429':
$ref: '#/components/responses/HTTP429'
summary: listOrgDevicesStats
tags:
- Orgs Stats - Devices
components:
schemas:
l2tp_state:
description: 'enum: `established`, `established_with_session`, `idle`, `wait-ctrl-conn`, `wait-ctrl-reply`'
enum:
- established
- established_with_session
- idle
- wait-ctrl-conn
- wait-ctrl-reply
examples:
- established
type: string
stats_gateway_mac_table_stats:
additionalProperties: false
description: Gateway MAC table utilization counters
properties:
mac_table_count:
description: Number of MAC table entries currently learned by the gateway
type: integer
max_mac_entries_supported:
description: Maximum MAC table entries supported by the gateway
type: integer
type: object
stats_switch_clients_stats:
additionalProperties: false
description: Aggregate switch client counts
properties:
total:
$ref: '#/components/schemas/stats_switch_clients_stats_total'
description: Aggregate client counts across the switch
type: object
stats_switch_port:
additionalProperties: false
description: Switch port statistics record returned by stats APIs
properties:
active:
description: Indicates if interface is active/inactive
readOnly: true
type: boolean
auth_state:
$ref: '#/components/schemas/port_auth_state'
description: Authentication state of the port
disabled:
description: Indicates if interface is disabled
readOnly: true
type: boolean
for_site:
description: Whether the reporting device is scoped to a specific site
readOnly: true
type: boolean
full_duplex:
description: Indicates full or half duplex
examples:
- true
type: boolean
jitter:
description: Last sampled jitter of the interface
readOnly: true
type: number
last_flapped:
description: Indicates when the port was last flapped
format: double
readOnly: true
type: number
latency:
description: Last sampled latency of the interface
readOnly: true
type: number
loss:
description: Last sampled loss of the interface
readOnly: true
type: number
lte_iccid:
description: LTE ICCID value, Check for null/empty
type:
- string
- 'null'
lte_imei:
description: LTE IMEI value, Check for null/empty
type:
- string
- 'null'
lte_imsi:
description: LTE IMSI value, Check for null/empty
type:
- string
- 'null'
mac:
description: Switch MAC address that reported these port statistics
examples:
- 5c4527a96580
readOnly: true
type: string
mac_count:
description: Number of MAC addresses in the forwarding table
readOnly: true
type: integer
mac_limit:
description: Limit on number of dynamically learned macs
minimum: 0
readOnly: true
type: integer
neighbor_mac:
description: chassis identifier of the chassis type listed
examples:
- 64d814353400
readOnly: true
type: string
neighbor_port_desc:
description: Description supplied by the system on the interface E.g. "GigabitEthernet2/0/39"
examples:
- GigabitEthernet1/0/21
readOnly: true
type: string
neighbor_system_name:
description: Name supplied by the system on the interface E.g. neighbor system name E.g. "Kumar-Acc-SW.mist.local"
examples:
- CORP-D-SW-2
readOnly: true
type: string
org_id:
$ref: '#/components/schemas/org_id'
description: Organization identifier of the reporting switch
poe_disabled:
description: Is the POE disabled
readOnly: true
type: boolean
poe_mode:
$ref: '#/components/schemas/stats_switch_port_poe_mode'
description: PoE mode reported for the port
poe_on:
description: Is the device attached to POE
readOnly: true
type: boolean
poe_priority:
$ref: '#/components/schemas/poe_priority'
description: PoE priority configured for the port
port_id:
description: Identifier of the port reporting these statistics
examples:
- ge-0/0/0
readOnly: true
type: string
port_mac:
description: MAC address assigned to the interface
examples:
- 5c4527a96580
readOnly: true
type: string
port_usage:
description: Logical usage assigned to the port
examples:
- lan
type: string
power_draw:
description: Amount of power being used by the interface at the time the command is executed. Unit in watts.
readOnly: true
type: number
rx_bcast_pkts:
description: Number of broadcast packets received on the interface
readOnly: true
type: integer
rx_bps:
$ref: '#/components/schemas/rx_bps'
description: Receive throughput of the port, in bits per second
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
description: Total bytes received on the port
rx_errors:
description: Number of receive errors observed on the interface
readOnly: true
type: integer
rx_mcast_pkts:
description: Number of multicast packets received on the interface
readOnly: true
type: integer
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
description: Total packets received on the port
site_id:
$ref: '#/components/schemas/site_id'
description: Site identifier of the reporting switch
speed:
description: Current link speed of the port, in Mbps
examples:
- 1000
readOnly: true
type: integer
stp_role:
$ref: '#/components/schemas/port_stp_role'
description: Current spanning tree role of the port
stp_state:
$ref: '#/components/schemas/port_stp_state'
description: Current spanning tree state of the port
tx_bcast_pkts:
description: Number of broadcast packets transmitted on the interface
readOnly: true
type: integer
tx_bps:
$ref: '#/components/schemas/tx_bps'
description: Transmit throughput of the port, in bits per second
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
description: Total bytes transmitted on the port
tx_errors:
description: Number of transmit errors observed on the interface
readOnly: true
type: integer
tx_mcast_pkts:
description: Number of multicast packets transmitted on the interface
readOnly: true
type: integer
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
description: Total packets transmitted on the port
type:
$ref: '#/components/schemas/stats_switch_port_type'
description: Detected device category connected to the port, when available
unconfigured:
description: Indicates if interface is unconfigured
readOnly: true
type: boolean
up:
description: Indicates if interface is up
readOnly: true
type: boolean
uplink:
description: Indicates if interface is an uplink port
readOnly: true
type: boolean
xcvr_model:
description: Optic Slot ModelName, Check for null/empty
examples:
- SFP+-10G-SR
readOnly: true
type: string
xcvr_part_number:
description: Optic Slot Partnumber, Check for null/empty
examples:
- 740-021487
readOnly: true
type: string
xcvr_serial:
description: Optic Slot SerialNumber, Check for null/empty
examples:
- N6AA9HT
readOnly: true
type: string
required:
- mac
- org_id
- port_id
- site_id
type: object
timestamp:
description: Epoch timestamp, in seconds
format: double
readOnly: true
type: number
stats_cluster_config_ethernet_connection:
description: Ethernet interface connection states for a gateway cluster
items:
$ref: '#/components/schemas/stats_cluster_config_ethernet_connection_item'
type: array
stats_ap:
additionalProperties: false
description: AP runtime statistics, placement data, and inventory metadata
properties:
antenna_select:
$ref: '#/components/schemas/antenna_select'
description: Selectable antenna mode reported for the AP
auto_placement:
$ref: '#/components/schemas/stats_ap_auto_placement'
description: Auto placement result and status for the AP
auto_upgrade_stat:
$ref: '#/components/schemas/stats_ap_auto_upgrade'
description: Automatic firmware upgrade status for the AP
ble_stat:
$ref: '#/components/schemas/stats_ap_ble'
description: BLE radio and beacon statistics reported by the AP
cert_expiry:
description: Certificate expiry timestamp for the AP, in epoch seconds
examples:
- 1534534392
readOnly: true
type:
- number
- 'null'
config_reverted:
description: Whether the AP configuration was reverted by the device
readOnly: true
type:
- boolean
- 'null'
cpu_system:
description: CPU system utilization reported by the AP
format: int64
readOnly: true
type:
- integer
- 'null'
cpu_user:
description: CPU user utilization reported by the AP
format: int32
readOnly: true
type:
- integer
- 'null'
cpu_util:
description: Total CPU utilization reported by the AP
format: int32
readOnly: true
type:
- integer
- 'null'
created_time:
$ref: '#/components/schemas/created_time'
description: Time when the AP record was created, in epoch seconds
deviceprofile_id:
description: Device profile identifier applied to the AP, when present
format: uuid
readOnly: true
type:
- string
- 'null'
env_stat:
$ref: '#/components/schemas/stats_ap_env_stat'
description: Environmental sensor readings reported by the AP
esl_stat:
$ref: '#/components/schemas/stats_ap_esl_stat'
description: Electronic shelf label dongle status reported by the AP
evpntopo_id:
description: EVPN topology identifier associated with the AP, when present
format: uuid
readOnly: true
type:
- string
- 'null'
expiring_certs:
$ref: '#/components/schemas/stats_ap_expiring_certs'
description: Certificates on the AP that are expiring within 30 days
ext_ip:
description: Public IP address observed for the AP
examples:
- 73.92.124.103
readOnly: true
type:
- string
- 'null'
fwupdate:
$ref: '#/components/schemas/fwupdate_stat'
description: Firmware update status for the AP
gps_stat:
$ref: '#/components/schemas/stats_ap_gps_stat'
description: GPS location data reported for the AP
hw_rev:
description: Hardware revision reported by the AP
readOnly: true
type:
- string
- 'null'
id:
$ref: '#/components/schemas/id'
description: Unique identifier for the AP
inactive_wired_vlans:
$ref: '#/components/schemas/integers'
description: Wired VLAN identifiers currently inactive on the AP
iot_stat:
$ref: '#/components/schemas/stats_ap_iot_stat'
description: IoT input statistics reported by the AP
ip:
description: Management IP address currently reported by the AP
examples:
- 10.2.9.159
readOnly: true
type:
- string
- 'null'
ip_config:
$ref: '#/components/schemas/ap_ip_config'
description: IP configuration applied to the AP management interface
ip_stat:
$ref: '#/components/schemas/ip_stat'
description: Read-only IP addressing status reported by the AP
l2tp_stat:
additionalProperties:
$ref: '#/components/schemas/stats_ap_l2tp_stat'
description: L2TP tunnel status (key is the wxtunnel_id)
type: object
last_seen:
$ref: '#/components/schemas/last_seen'
description: Time when the AP was last seen by Mist, in epoch seconds
last_trouble:
$ref: '#/components/schemas/last_trouble'
description: Most recent AP trouble indicator and timestamp
led:
$ref: '#/components/schemas/ap_led'
description: Light indicator state for the AP
lldp_stat:
$ref: '#/components/schemas/stats_ap_lldp_stat'
description: Primary LLDP neighbor and power negotiation details for the AP
lldp_stats:
$ref: '#/components/schemas/stats_ap_lldp_stats'
description: Per-port LLDP neighbor and power negotiation details for the AP
locating:
description: Whether AP locating mode is currently active
examples:
- false
readOnly: true
type:
- boolean
- 'null'
locked:
description: Whether this AP is considered locked (placement / orientation has been vetted)
examples:
- true
readOnly: true
type:
- boolean
- 'null'
mac:
description: AP MAC address reported by Mist
examples:
- 5c5b35000010
readOnly: true
type:
- string
- 'null'
map_id:
description: Map identifier where the AP is placed, when available
examples:
- 63eda950-c6da-11e4-a628-60f81dd250cc
format: uuid
readOnly: true
type:
- string
- 'null'
mem_total_kb:
description: Total memory available on the AP, in kilobytes
format: int64
readOnly: true
type:
- integer
- 'null'
mem_used_kb:
description: Memory currently used on the AP, in kilobytes
format: int64
readOnly: true
type:
- integer
- 'null'
mesh_downlinks:
additionalProperties:
$ref: '#/components/schemas/ap_stat_mesh_downlink'
description: Property key is the mesh downlink id (e.g. `00000000-0000-0000-1000-5c5b35000010`)
type: object
mesh_uplink:
$ref: '#/components/schemas/ap_stat_mesh_uplink'
description: Mesh uplink status for the AP
model:
description: AP model identifier reported by Mist
examples:
- AP200
readOnly: true
type:
- string
- 'null'
modified_time:
$ref: '#/components/schemas/modified_time'
description: Time when the AP record was last modified, in epoch seconds
mount:
description: Orientation configured for the AP mount
examples:
- faceup
readOnly: true
type:
- string
- 'null'
name:
description: Display name of the AP
examples:
- conference room
readOnly: true
type:
- string
- 'null'
notes:
description: Free-form notes configured on the AP record
readOnly: true
type:
- string
- 'null'
num_clients:
description: How many wireless clients are currently connected
readOnly: true
type:
- integer
- 'null'
num_wlans:
description: How many WLANs are applied to the device
type: integer
org_id:
$ref: '#/components/schemas/org_id'
description: Organization identifier that owns the AP
port_stat:
additionalProperties:
$ref: '#/components/schemas/stats_ap_port_stat'
description: Property key is the port name (e.g. `eth0`)
readOnly: true
type:
- object
- 'null'
power_budget:
description: In mW, surplus if positive or deficit if negative
examples:
- 1000
format: int32
readOnly: true
type:
- integer
- 'null'
power_constrained:
description: Whether the AP is operating with insufficient power
examples:
- false
readOnly: true
type:
- boolean
- 'null'
power_opmode:
description: Operating mode used while AP power is constrained
examples:
- '[20] 6GHz(2x2) 5GHz(4x4) 2.4GHz(2x2).'
readOnly: true
type:
- string
- 'null'
power_src:
description: DC Input / PoE 802.3at / PoE 802.3af / LLDP / ? (unknown)
examples:
- PoE 802.3af
readOnly: true
type:
- string
- 'null'
radio_config:
$ref: '#/components/schemas/stats_ap_radio_config'
description: Radio configuration currently applied to the AP
radio_stat:
$ref: '#/components/schemas/stats_ap_radio_stat'
description: Radio statistics reported by AP bands
rx_bps:
$ref: '#/components/schemas/rx_bps'
description: Receive throughput for AP traffic, in bits per second
rx_bytes:
$ref: '#/components/schemas/rx_bytes'
description: Total bytes received by the AP since connection
rx_pkts:
$ref: '#/components/schemas/rx_pkts'
description: Total packets received by the AP since connection
serial:
description: Device serial number for the AP
examples:
- FXLH2015170017
readOnly: true
type:
- string
- 'null'
site_id:
$ref: '#/components/schemas/site_id'
description: Site identifier where the AP is assigned
status:
description: Connection status reported for the AP
readOnly: true
type:
- string
- 'null'
switch_redundancy:
$ref: '#/components/schemas/stats_ap_switch_redundancy'
description: Switch redundancy status reported for the AP
tx_bps:
$ref: '#/components/schemas/tx_bps'
description: Transmit throughput for AP traffic, in bits per second
tx_bytes:
$ref: '#/components/schemas/tx_bytes'
description: Total bytes transmitted by the AP since connection
tx_pkts:
$ref: '#/components/schemas/tx_pkts'
description: Total packets transmitted by the AP since connection
type:
$ref: '#/components/schemas/const_device_type_ap'
description: Device type for this statistics record
uptime:
description: How long, in seconds, has the device been up (or rebooted)
examples:
- 13500
readOnly: true
type:
- number
- 'null'
usb_stat:
$ref: '#/components/schemas/stats_ap_usb_stat'
description: USB peripheral status reported by the AP
version:
description: Firmware version running on the AP
examples:
- 0.14.12345
readOnly: true
type:
- string
- 'null'
x:
description: Map X coordinate of the AP placement, in pixels
examples:
- 53.5
format: double
readOnly: true
type:
- number
- 'null'
y:
description: Map Y coordinate of the AP placement, in pixels
examples:
- 173.1
format: double
readOnly: true
type:
- number
- 'null'
required:
- type
title: stats_ap
type: object
stats_devices:
description: Device statistics records returned by a stats response
items:
$ref: '#/components/schemas/stats_device'
type: array
id:
description: Unique ID of the object instance in the Mist Organization
examples:
- 53f10664-3ce8-4c27-b382-0ef66432349f
format: uuid
readOnly: true
type: string
tunnel_priority:
description: 'Relative preference assigned to the tunnel. enum: `primary`, `secondary`'
enum:
- primary
- secondary
type: string
stats_cluster_config_control_link_info:
additionalProperties: false
description: Control link status details for a gateway cluster
properties:
name:
description: Control link interface name reported by the gateway cluster
type: string
status:
description: Operational state reported for the control link
type: string
type: object
ip_stat:
additionalProperties: false
description: Read-only IP addressing status reported by a device interface
properties:
dhcp_server:
description: Reported DHCP server IPv4 address for the interface, when available
examples:
- 192.168.95.1
readOnly: true
type:
- string
- 'null'
dns:
$ref: '#/components/schemas/strings'
description: Reported DNS server addresses for the interface
dns_suffix:
$ref: '#/components/schemas/strings'
description: Reported DNS search suffixes for the interface
gateway:
description: Current IPv4 default gateway for the interface, when available
readOnly: true
type:
- string
- 'null'
gateway6:
description: Current IPv6 default gateway for the interface, when available
examples:
- fdad:b0bc:f29e::1
readOnly: true
type:
- string
- 'null'
ip:
description: Current IPv4 address for the interface, when available
examples:
- 10.3.3.1
readOnly: true
type:
- string
- 'null'
ip6:
description: Current IPv6 address for the interface, when available
examples:
- fdad:b0bc:f29e::3d16
readOnly: true
type:
- string
- 'null'
ips:
additionalProperties:
$ref: '#/components/schemas/ip_stat_ips'
description: Per-VLAN IP address summaries keyed by VLAN name
type: object
netmask:
description: Current IPv4 subnet mask for the interface, when available
examples:
- 255.255.255.0
readOnly: true
type:
- string
- 'null'
netmask6:
description: Current IPv6 prefix length for the interface, when available
examples:
- /64
readOnly: true
type:
- string
- 'null'
type: object
dot11_bandwidth:
description: 'channel width for the band.enum: `0`(disabled, response only), `20`, `40`, `80` (only applicable for band_5 and band_6), `160` (only for band_6)'
enum:
- 0
- 20
- 40
- 80
- 160
examples:
- 20
type: integer
device_enum_with_all:
default: ap
description: 'device type. enum: `all`, `ap`, `gateway`, `switch`. Default is `ap`'
enum:
- all
- ap
- switch
- gateway
type: string
stats_switch_port_poe_mode:
description: 'enum: `802.3af`, `802.3at`, `802.3bt`'
enum:
- 802.3af
- 802.3at
- 802.3bt
type: string
stats_gateway_spu_item:
additionalProperties: false
description: Services Processing Unit resource and session counters
properties:
spu_cpu:
description: CPU utilization reported for the Services Processing Unit
examples:
- 3670632
type: integer
spu_current_session:
description: Current session count handled by the Services Processing Unit
examples:
- 215
type: integer
spu_max_session:
description: Maximum sessions supported by the Services Processing Unit
examples:
- 131072
type: integer
spu_memory:
description: Memory utilization reported for the Services Processing Unit
examples:
- 46
type: integer
spu_pending_session:
description: Pending session count on the Services Processing Unit
examples:
- 0
type: integer
spu_uptime:
description: Elapsed time since the Services Processing Unit started, in seconds
examples:
- 0
type: integer
spu_valid_session:
description: Valid session count currently tracked by the Services Processing Unit
type: integer
ip_stat_ips:
description: Property key is the VLAN name
readOnly: true
type:
- string
- 'null'
ap_ip_config_dns:
description: If `type`==`static`. DNS server IP addresses for AP management traffic
examples:
- - 8.8.8.8
- 4.4.4.4
items:
type: string
type: array
response_http400:
additionalProperties: false
description: Standard HTTP 400 bad request error response
properties:
detail:
description: Human-readable explanation of the bad request error
examples:
- 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
type: string
type: object
last_seen:
description: Timestamp indicating when the entity was last seen
examples:
# --- truncated at 32 KB (175 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-orgs-stats-devices-api-openapi.yml