Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsStats

getOrgStats

GET
/api/v1/orgs/{org_id}/stats

Return an organization statistics summary, including device, inventory, and site counts, connected and disconnected device counts, organization group membership, and SLE summaries.

Authorization

Authorization<token>

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

org_id*string
Formatuuid

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/stats"
{  "alarmtemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "allow_mist": true,  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "msp_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "name": "string",  "num_devices": 0,  "num_devices_connected": 0,  "num_devices_disconnected": 0,  "num_inventory": 0,  "num_sites": 0,  "orggroup_ids": [    "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"  ],  "session_expiry": 0,  "sle": [    {      "path": "string",      "user_minutes": {        "ok": 0,        "total": 0      }    }  ]}

updateOrgSsoRole PUT

Update an organization SSO role definition, including its display name and granted privileges.

countOrgAssetsByDistanceField GET

Count organization asset statistics grouped by a distinct asset attribute, such as MAC address, site, map, iBeacon UUID, iBeacon major, or iBeacon minor.