List Events for a Monitor
Lists all Events that have been triggered for a Monitor within the saved time frame (usually 90 days).
Endpoint | Method | URL |
---|---|---|
/monitors/{id}/events | GET | https://garmingo.com/api/status/v1/monitors/{id}/events |
Query Parameters
Parameter | Type | Description | Required | Default | Minimum | Maximum |
---|---|---|---|---|---|---|
limit | number | The maximum number of Events to return. | No | 10 | 1 | 100 |
page | number | The page number of the Events to return. | No | 1 | 1 | ∞ |
Response
The response is a JSON object with the following properties:
Property | Type | Description |
---|---|---|
success | boolean | Whether the request was successful. |
data.events | Event[] | The list of Events. |
data.count | number | The total number of Events. |
Example
{
"success": true,
"data": {
"events": [
{
"id": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
"monitorId": "5f4b3b3b-0b3b-4b3b-0b3b-4b3b0b3b0b3b",
"status": true,
"timestamp": "2021-01-01T00:00:00.000Z",
"metadata": {
"key": "value"
}
}
],
"count": 1
}
}