OrgsDevices

countOrgDeviceEvents

GET
/api/v1/orgs/{org_id}/devices/events/count

Count device event records across the organization, optionally grouped by distinct and filtered by site, AP, firmware, model, event text, event type, and time range.

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

distinct?string

Field used to group this count response. enum: ap, apfw, model, org_id, site_id, status, text, timestamp, type

Default"model"

Value in

  • "ap"
  • "apfw"
  • "model"
  • "org_id"
  • "site_id"
  • "text"
  • "timestamp"
  • "type"
site_id?string

Filter results by site identifier

Formatuuid
ap?string

Filter results by AP MAC address

apfw?string

Filter results by AP firmware version

model?string

Filter results by device model

text?string

Filter results by event message text

type?string
includes?string

Keyword to include events from additional indices (e.g. ext_tunnel for ext tunnel events)

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"
limit?integer

Maximum number of results to return per page

Range0 <= value
Default100

Response Body

curl -X GET "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/devices/events/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}