Common Response Fields
All API responses include the fields below prior to the
events block:
{
"count": 1,
"streamPosition": "1583",
"moreEvents": true,
"requestId": "497a5de3-1a85-4a7c-9ac3-e81098e4fd82",
"links": [
{
"href": "/events",
"rel": "events"
},
{
"href": "/events?streamPosition=1583",
"rel": "next"
}
],
"events": [...]
}| Field | Type | Description |
|---|---|---|
|
Integer | Number of events returned in the response. |
|
String | Only included if the query specified the
streamPosition parameter. Value to use in subsequent GET requests in order to obtain more events. |
|
Boolean |
true if there are more events after those included in this response. |
|
Integer | Only included if the query specified the
offset parameter. The total number of events that match the filter parameters in the query. |
|
UUID | Unique ID that identifies the request. Primarily for use by Lookout when troubleshooting issues. |
|
String array | HATEOAS hypermedia links for the query. |
