GuidesAPI Reference
API Reference
These docs are for v1.0. Click to read the latest docs for v2.0.

Alerts (Summary)

get
https://api.freedomrobotics.ai/accounts//devices//alerts/summary

The API will return a redirect link that downloads a csv file with all alerts that were active for the device in specified time interval.

Path Params
string
required
string
required
Query Params
string
Defaults to -7d

The starting range of the time window for capturing alerts.

string
Defaults to now

The end range of the time window for capturing alerts.

string

Groups the alerts based on an attribute of the alert. For example "creation_timestamp" or "clearance_timestamp".

string

Counts the alerts based on the query param provided. By default it is level, but you can specify attributes like "name" or "description"."

Responses

Updated almost 5 years ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated almost 5 years ago