Alerts
Alerts are the backbone of reporting and it keeps all elements of an alert. Alerts can be queried by string parameters and camera. Alert API works with unix timestamp as the start and end time of the queried alerts and those are required for all type of API calls. So it returns alerts, which created in the given time period only.
It is recommended to use frequent API calls by keeping the distance between start and end time, because it is easier to manage less alerts at a time. However there is no limitation on start and end times, it is completely up to your scripting structure.
Export alerts based on time interval
GET/alerts/export
Arguments
Query String Parameters
- start
Long
required The timestamp where the alerts are happened later - end
Long
required The timestamp where the alerts are happened earlier - format
Enum
optional- CSV (default)
- JSON
- JSONL
- alertType
Enum
optional- HELMET
- FACE_MASK
- GLOVE...
- alertRuleId
UUID
optional - severity
Enum
optional- LOW
- MEDIUM
- HIGH
- observation
Boolean
optional - limit
Int
optional
Returns
Returns list of alert objects for given parameters.
Field | Type | Description |
---|---|---|
id | UUID | Unique identifier for alert |
name | Enum | Alert name ex: GLOVE, HELMET |
localCreatedAt | DateTime | Alert creation date |
alertRuleId | UUID optional | Alert rule id |
cameraId | UUID | Unique identifier for a camera in which alert is created from |
facilityId | UUID | Unique identifier for a facility |
severity | Enum | Severity type ex: HIGH, MEDIUM & LOW |
observation | Boolean | The field shows that an alert is created for just observation or not |
falsePositive | Boolean optional | The field shows that an alert is marked as false positive by Intenseye team |
customerFalsePositive | Boolean optional | The field shows that an alert is marked as false positive by customers |
- Csv
- Json
- Json Lines
id,name,localCreatedAt,alertRuleId,cameraId,facilityId,severity,observation,falsePositive,customerFalsePositive
a68b9378-1a8b-427a-bc6b-a644212a0cb8,HELMET,2022-10-04T20:47:00Z,bd087d4f-13e2-4044-900e-7188b1d4cc0d,d875c064-e8d9-434e-9cee-6996f1549888,3fa85f64-5717-4562-b3fc-2c963f66afa6,LOW,false,true,
cccd2663-1fa4-40c9-9739-162e474f5c88,GLOVE,2022-10-04T20:51:00Z,bd087d4f-13e2-4044-900e-7188b1d4cc0d,d875c064-e8d9-434e-9cee-6996f1549888,3fa85f64-5717-4562-b3fc-2c963f66afa6,LOW,false,false,
[
{
"id": "a68b9378-1a8b-427a-bc6b-a644212a0cb8",
"name": "HELMET",
"localCreatedAt": "2022-10-04T20:47:00Z",
"alertRuleId": "bd087d4f-13e2-4044-900e-7188b1d4cc0d",
"cameraId": "d875c064-e8d9-434e-9cee-6996f1549888",
"facilityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"severity": "LOW",
"observation": false,
"falsePositive": true,
"customerFalsePositive": null
},
{
"id": "cccd2663-1fa4-40c9-9739-162e474f5c88",
"name": "GLOVE",
"localCreatedAt": "2022-10-04T20:51:00Z",
"alertRuleId": "bd087d4f-13e2-4044-900e-7188b1d4cc0d",
"cameraId": "d875c064-e8d9-434e-9cee-6996f1549888",
"facilityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"severity": "LOW",
"observation": false,
"falsePositive": false,
"customerFalsePositive": null
}
]
{"id":"a68b9378-1a8b-427a-bc6b-a644212a0cb8","name":"HELMET","localCreatedAt":"2022-10-04T20:47:00Z","alertRuleId":"bd087d4f-13e2-4044-900e-7188b1d4cc0d","cameraId":"d875c064-e8d9-434e-9cee-6996f1549888","facilityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","severity":"LOW","observation":false,"falsePositive": true, "customerFalsePositive": null}
{"id":"cccd2663-1fa4-40c9-9739-162e474f5c88","name":"GLOVE","localCreatedAt":"2022-10-04T20:51:00Z","alertRuleId":"bd087d4f-13e2-4044-900e-7188b1d4cc0d","cameraId":"d875c064-e8d9-434e-9cee-6996f1549888","facilityId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","severity":"LOW","observation":false,"falsePositive": false, "customerFalsePositive": null}