Description
Retrieve a list of events.
Request
HTTP Method: GET
Parameter | Description |
---|---|
since_id | Optional Only retrieve events after this ID. |
until_id | Optional Only retrieve events until (and including) this ID. |
team_id | Optional Filter by the given team. |
story_id | Optional Filter by the given story. |
include_groups | Optional Include events from groups in the specified story. Only valid if story_id is specified. Boolean, defaults to false . |
per_page | Optional Set the number of results returned per page. Defaults to 20. |
page | Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. |
curl -X GET \
https://<<META.tenant.domain>>/api/v1/events \
-H 'content-type: application/json' \
-H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
Response
A successful request will return a JSON Array describing events in the Tines tenant.
Field description
Parameter | Description |
---|---|
id | Event ID. |
agent_id | ID of action that emitted the event. |
payload | JSON representation of the event payload. |
created_at | ISO 8601 Timestamp representing date and time the event was emitted. |
updated_at | ISO 8601 Timestamp representing date and time the event was last updated. Will always by the same as 'created_at'. |
story_run_guid | Unique identifier of that event's story run. |
previous_event_ids | IDs of the upstream action's events in that event's story run. |
Sample response
{
[
{
"id": 1785421735,
"user_id": 1,
"agent_id": 21,
"payload": {
"propagation_webhook": {
"username": "joe.bloggs",
"age": 99
},
"delay_http_request": {
"body": {
"delay": "5"
},
"headers": {
"access-control-allow-credentials": "",
"access-control-allow-headers": "",
"access-control-allow-methods": "",
"access-control-allow-origin": "",
"access-control-expose-headers": "",
"content-type": "application/json; charset=utf-8",
"date": "Tue, 03 Apr 2018 13:37:24 GMT",
"etag": "W/\"d-N6WkUL2Jgn7fCGyPWbbptw\"",
"server": "nginx",
"set-cookie": "sails.sid=s%3A6Hr22AAbEOurnGiqRo3; Path=/; HttpOnly",
"vary": "Accept-Encoding",
"content-length": "13",
"connection": "Close"
},
"status": 200
}
},
"created_at": "2018-04-03T13:37:24.479Z",
"updated_at": "2018-04-03T13:37:24.479Z",
"story_run_guid": "d59cd024-38b2-4287-b298-a8ee8dc86863",
"previous_events_ids": [1785155927]
}
]
"meta": {
"current_page": "https://<<META.tenant.domain>>/api/v1/events?page=1&per_page=20",
"previous_page": null,
"next_page": null,
"next_page_number": null,
"per_page": 20,
"pages": 1,
"count": 1
}
}