Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsClientsMarvis

searchOrgMarvisClientEvents

GET
/api/v1/orgs/{org_id}/marvisclients/events/search

Search Marvis Client events across the organization.

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

Query Parameters

type?string

Filter by event type

device_id?string

Filter by Marvis Client installation device UUID

wifi_mac?string

Filter by device Wi-Fi MAC address

wifi_ip?string

Filter by device Wi-Fi IP address

hostname?string

Filter by device hostname

ssid?string

Filter by SSID involved in roam events

bssid?string

Filter by BSSID the client roamed to

channel?string

Filter by channel the client roamed to

pre_bssid?string

Filter by BSSID the client roamed from

pre_channel?string

Filter by channel the client roamed from

limit?integer

Maximum number of results to return per page

Range0 <= value
Default100
start?string

Lower bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d or -1w

end?string

Upper bound of the time range, as an epoch timestamp in seconds or a relative value such as -1d, -2h, or now

duration?string

Time range duration for the query, using relative units such as 10m, 7d, or 2w

Default"1d"

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/marvisclients/events/search"
{  "limit": 1000,  "results": [    {      "bssid": "5c5b35000002",      "channel": 11,      "device_id": "da088609-8e8d-6d8b-0e40-fe1dc94b9218",      "hostname": "jdoe123-dell",      "location": {        "map_id": "7735ef91-83b4-6116-1c1a-57819af48867",        "site_id": "4ac1dcf4-9d8b-7211-65c4-057819f0862b",        "timestamp": 1678377926,        "x": 12.5,        "y": 45      },      "neighbor_ap_report": [        {          "band": "5",          "bssid": "5c5b35000003",          "channel": 44,          "rssi": -55        },        {          "band": "5",          "bssid": "5c5b35000004",          "channel": 36,          "rssi": -70        }      ],      "org_id": "2818e386-8dec-2562-9ede-5b8a0fbbdc71",      "pre_bssid": "5c5b35000001",      "pre_channel": 7,      "pre_rssi": -76,      "rssi": -53,      "ssid": "Corp",      "timestamp": 1678377926,      "type": "MARVISCLIENT_ROAMED",      "wifi_ip": "10.10.20.1",      "wifi_mac": "f01c2df166e0"    },    {      "device_id": "da088609-8e8d-6d8b-0e40-fe1dc94b9218",      "hostname": "jdoe123-dell",      "org_id": "2818e386-8dec-2562-9ede-5b8a0fbbdc71",      "percent": 9,      "timestamp": 1678378040,      "type": "MARVISCLIENT_LOW_BATTERY",      "wifi_ip": "10.10.20.1",      "wifi_mac": "f01c2df166e0"    }  ],  "total": 1}

getOrgMarvisClientInsights GET

Return time-series metrics for a specific Marvis Client device. For the full list of supported metric field names and example values, refer to [List Insight Metrics](/api/mist/constants/constants-definitions/listInsightMetrics) under `/api/v1/const/insight_metrics`.

countOrgNacClientEvents GET

Count NAC client events across the organization, optionally grouped by `distinct` and filtered by event type and time range.