Get Events

Get all events of a specific project.

Get Events request supports pagination.

get
Get Events

https://environment.lvis.io/api/v2/projects/:project_id/events
Request
Response
Request
Path Parameters
project_id
required
string
Project ID.
Headers
Authorization
required
string
Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type
required
string
application/vnd.api+json
Query Parameters
filter[only_listings]
optional
string
Filter events in order to display only those that are included in listings. Possible values: true, false.
include
optional
string
Include additional relation to the response. For example, include=stats adds event stats to the response. Possible values: stats, project. In order to include more than one relation, provide them separated by commas.
filter[state]
required
string
Filter events by state. In order to filter events by multiple states, provide them separated by commas. Possible values: future, current, on_demand, past.
page[cursor]
optional
string
Pagination cursor.
page[count]
optional
integer
Page size.
sort
optional
string
Sorting order. Possible values: start_time (default) - from earlier to later start time, -start_time - from later to earlier start time.
Response
200: OK
{
"data": [
{
"id": "a7fde717-6100-4377-8530-fbad083eb768",
"type": "events",
"attributes": {
"name": "Event",
"duration": 60,
"start_mode": "manual",
"state": "future",
"actions": [],
"original_duration": 60,
"repeat": false,
"repeat_in": null,
"start_at": 1554392102,
"start_at_iso": "2019-04-04T15:35:02Z",
"end_at": 1554392162,
"end_at_iso": "2019-04-04T15:36:02Z",
"settings": [
{
"key": "text",
"values": {
"all": "value"
}
},
],
"live_stats_uuid": null,
"on_demand_duration": null,
"extra_time_duration": null
},
"relationships": {
"elements": {
"links": {
"related": "https://environment.lvis.io/api/v2/events/a7fde717-6100-4377-8530-fbad083eb768/elements"
}
},
"pause_markers": {
"links": {
"related": "https://environment.lvis.io/api/v2/events/a7fde717-6100-4377-8530-fbad083eb768/pause_markers"
}
},
"stats": {
"data": {
"id": "a7fde717-6100-4377-8530-fbad083eb768",
"type": "stats"
}
},
"project": {
"data": {
"id": "55aecc98-87d4-4c42-b9c9-c8d76e924452",
"type": "projects"
}
}
},
"links": {
"self": "https://environment.lvis.io/api/v2/events/a7fde717-6100-4377-8530-fbad083eb768"
}
}
],
"links": {
"prev": "https://environment.lvis.io/api/v2/projects/55aecc98-87d4-4c42-b9c9-c8d76e924452/events?filter[state]=future&page[count]=20&page[cursor]=eyJmcm9tIjoxNTU0MzkyMTAyMDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6Ijg1NyIsImZvcndhcmQiOmZhbHNlfQ",
"next": "https://environment.lvis.io/api/v2/projects/55aecc98-87d4-4c42-b9c9-c8d76e924452/events?filter[state]=future&page[count]=20&page[cursor]=eyJmcm9tIjoxNTU0MzkyMTAyMDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6Ijg1NyIsImZvcndhcmQiOnRydWV9"
}
}

Example

curl --request GET \
--url https://environment.lvis.io/api/v2/projects/a7fde717-6100-4377-8530-fbad083eb768/events?filter[only_listings]=true&filter[state]=future \
--header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
--header 'Content-Type: application/vnd.api+json'