Get a list of events
GET {{baseUrl}}/api/v2/events
List endpoint returns events that match an events search query. Results are paginated similarly to logs.
Use this endpoint to see your latest events.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
filter[query] | string | Search query following events syntax. | |
filter[from] | string | Minimum timestamp for requested events. | |
filter[to] | string | Maximum timestamp for requested events. | |
sort | string | Order of events in results. | |
page[cursor] | string | List following results with a cursor provided in the previous query. | |
page[limit] | number | Maximum number of events in the response. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"attributes":{"aggregation_key":"\u003cstring\u003e","date_happened":"\u003clong\u003e","device_name":"\u003cstring\u003e","duration":"\u003clong\u003e","event_object":"\u003cstring\u003e","evt":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","source_id":"\u003clong\u003e","type":"\u003cstring\u003e"},"hostname":"\u003cstring\u003e","monitor":{"created_at":"\u003clong\u003e","group_status":"\u003cinteger\u003e","groups":["\u003cstring\u003e","\u003cstring\u003e"],"id":"\u003clong\u003e","message":"\u003cstring\u003e","modified":"\u003clong\u003e","name":"\u003cstring\u003e","query":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"templated_name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"monitor_groups":["\u003cstring\u003e","\u003cstring\u003e"],"monitor_id":"\u003clong\u003e","priority":"normal","related_event_id":"\u003clong\u003e","service":"\u003cstring\u003e","source_type_name":"\u003cstring\u003e","sourcecategory":"\u003cstring\u003e","status":"success","tags":["\u003cstring\u003e","\u003cstring\u003e"],"timestamp":"\u003clong\u003e","title":"\u003cstring\u003e"},"message":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"timestamp":"\u003cdateTime\u003e"},"id":"\u003cstring\u003e","type":"event"},{"attributes":{"attributes":{"aggregation_key":"\u003cstring\u003e","date_happened":"\u003clong\u003e","device_name":"\u003cstring\u003e","duration":"\u003clong\u003e","event_object":"\u003cstring\u003e","evt":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","source_id":"\u003clong\u003e","type":"\u003cstring\u003e"},"hostname":"\u003cstring\u003e","monitor":{"created_at":"\u003clong\u003e","group_status":"\u003cinteger\u003e","groups":["\u003cstring\u003e","\u003cstring\u003e"],"id":"\u003clong\u003e","message":"\u003cstring\u003e","modified":"\u003clong\u003e","name":"\u003cstring\u003e","query":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"templated_name":"\u003cstring\u003e","type":"\u003cstring\u003e"},"monitor_groups":["\u003cstring\u003e","\u003cstring\u003e"],"monitor_id":"\u003clong\u003e","priority":"low","related_event_id":"\u003clong\u003e","service":"\u003cstring\u003e","source_type_name":"\u003cstring\u003e","sourcecategory":"\u003cstring\u003e","status":"warning","tags":["\u003cstring\u003e","\u003cstring\u003e"],"timestamp":"\u003clong\u003e","title":"\u003cstring\u003e"},"message":"\u003cstring\u003e","tags":["\u003cstring\u003e","\u003cstring\u003e"],"timestamp":"\u003cdateTime\u003e"},"id":"\u003cstring\u003e","type":"event"}],"links":{"next":"\u003cstring\u003e"},"meta":{"elapsed":"\u003clong\u003e","page":{"after":"\u003cstring\u003e"},"request_id":"\u003cstring\u003e","status":"\u003cstring\u003e","warnings":[{"code":"\u003cstring\u003e","detail":"\u003cstring\u003e","title":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","detail":"\u003cstring\u003e","title":"\u003cstring\u003e"}]}}