SitesServices

countSiteServicePathEvents

GET
/api/v1/sites/{site_id}/services/events/count

Count by Distinct Attributes of Service Path Events

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

site_id*string
Formatuuid

Query Parameters

distinct?string

Field used to group this count response. enum: mac, model, policy, port_id, site_id, type, vpn_name, vpn_path

Default"type"

Value in

  • "mac"
  • "model"
  • "policy"
  • "port_id"
  • "site_id"
  • "type"
  • "vpn_name"
  • "vpn_path"
type?string

Event type, e.g. GW_SERVICE_PATH_DOWN

text?string

Description of the event including the reason it is triggered

vpn_name?string

Filter results by vpn name

vpn_path?string

Filter results by vpn path

policy?string

Service policy associated with that specific path

port_id?string

Filter results by port identifier

model?string

Filter results by device model

version?string

Filter results by software version

mac?string

Filter results by MAC address

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/sites/000000ab-00ab-00ab-00ab-0000000000ab/services/events/count"
{  "distinct": "string",  "end": 0,  "limit": 0,  "results": [    {      "count": 0,      "property": "string"    }  ],  "start": 0,  "total": 0}