Skip to main content

​
What you can do

Sites

List the sites in your organization, including each site’s time zone.

Sensors

List sensors, optionally filtered to a single site.

Workflows

List the workflows configured for a site and the sensors active in each one.

Alert summaries

Count alert events by outcome (pending, resolved, dismissed) over hourly, daily, or weekly buckets.

​
Making requests

All endpoints live under the /api/v1 path, accept GET requests, and return JSON. Authenticate every request with an API key passed as a bearer token. See Authentication.

​
Pagination

The list endpoints (/sites, /sensors, and /workflows) use cursor-based pagination.
​
integer
Maximum number of items to return. For /sites, the default and maximum are both 100.
​
string
The nextPageToken value from a previous response. Omit it to fetch the first page.
Each list response includes a nextPageToken. Pass it as pageToken on your next request to get the following page, and continue until you have retrieved every item.

​
Alert summary limits

GET /api/v1/alerts/summary takes inclusive startDate and endDate values (YYYY-MM-DD) in each site’s local calendar. Granularity defaults to daily. Ranges are limited to:
  • Hourly: up to 31 days
  • Daily or weekly: up to 366 days
  • Any granularity: at most 10,000 rows
Requests over these limits return 400 with the report_too_large error code. In every bucket, pendingEventCount + resolvedEventCount + dismissedEventCount equals alertEventCount.