Get Event

Get event with specified identifier.

get
Get Event

https://environment.lvis.io/api/v2/events/:event_id
Request
Response
Request
Path Parameters
event_id
required
string
Event ID.
Headers
Authorization
required
string
Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type
required
string
application/vnd.api+json
Query Parameters
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.
Response
200: OK
{
"data": {
"id": "4ba39f91-627f-4668-92be-9519a803e06d",
"type": "events",
"attributes": {
"name": "Event Name",
"duration": 3600,
"original_duration": 3600,
"start_mode": "manual",
"repeat": false,
"repeat_in": null,
"live_stats_uuid": null,
"on_demand_duration": null,
"extra_time_duration": null,
"start_at": 1546290000,
"start_at_iso": "2018-12-31T21:00:00Z",
"end_at": 1546293600,
"end_at_iso": "2018-12-31T22:00:00Z",
"settings": [
{
"key": "bool",
"values": {
"all": true
}
},
......
],
"state": "future",
"actions": [
]
},
"relationships": {
"elements": {
"links": {
"related": "https://example.lvis.io/api/v2/events/4ba39f91-627f-4668-92be-9519a803e06d/elements"
}
},
"pause_markers": {
"links": {
"related": "https://example.lvis.io/api/v2/events/4ba39f91-627f-4668-92be-9519a803e06d/pause_markers"
}
},
"stats": {
"data": {
"id": "4ba39f91-627f-4668-92be-9519a803e06d",
"type": "stats"
}
},
"project": {
"data": {
"id": "fe5eba4d-d7b6-408f-a393-39bc8f41d2c5",
"type": "projects"
}
}
},
"links": {
"self": "https://example.lvis.io/api/v2/events/4ba39f91-627f-4668-92be-9519a803e06d"
}
}
}

Example

curl --request GET \
--url https://environment.lvis.io/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323 \
--header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
--header 'Content-Type: application/vnd.api+json'

Get event with stats and project

cURL
Response
cURL
curl --request GET \
--url https://environment.lvis.io/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323?include=stats,project \
--header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
--header 'Content-Type: application/vnd.api+json'
Response
// Status: 200 OK
{
"data": {
"id": "b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323",
"type": "events",
"attributes": {
"name": "Event Name",
"duration": 3600,
"original_duration": 3600,
"start_mode": "manual",
"repeat": false,
"repeat_in": null,
"live_stats_uuid": null,
"on_demand_duration": null,
"extra_time_duration": null,
"start_at": 1546290000,
"start_at_iso": "2018-12-31T21:00:00Z",
"end_at": 1546293600,
"end_at_iso": "2018-12-31T22:00:00Z",
"settings": [
{
"key": "bool",
"values": {
"all": true
}
},
......
],
"state": "future",
"actions": [
]
},
"relationships": {
"elements": {
"links": {
"related": "https://example.lvis.io/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323/elements"
}
},
"pause_markers": {
"links": {
"related": "https://example.lvis.io/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323/pause_markers"
}
},
"stats": {
"data": [
]
},
"project": {
"data": {
"id": "eb7df570-09e3-41f9-bcc0-e179f7e74415",
"type": "projects"
}
}
},
"links": {
"self": "https://example.lvis.io/api/v2/events/b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323"
}
},
"included": [
{
"id": "b9cb1ba0-d1d3-4f44-8248-d78f8bd4a323",
"type": "stats",
"attributes": {
"interactions": 0,
"peak_concurrency": 0,
"current_concurrency": 0,
"unique_users": 0,
"average_session_length": 0,
"elements_count": 0
}
},
{
"id": "a8e22ad3-b8b1-4fe2-a08a-45e5ba39df7d",
"type": "projects",
"attributes": {
"name": "Project",
"locales": [
{
"active": true,
"default": false,
"key": "de"
},
{
"active": true,
"default": true,
"key": "en"
}
],
"certification_enabled": true,
"settings": [],
"history_ignore": 45,
"audio_sync_default_delay": 2,
"audio_sync_max_delay": 5,
"embed": "//apps.lvis.tv/elements/20.2.1/app.html?p=a8e22ad3-b8b1-4fe2-a08a-45e5ba39df7d&h=d3vtzxnppyvur.cloudfront.net",
"assets": {},
},
"relationships": {
"events": {
"links": {
"related": "http://example.lvis.io/api/v2/projects/a8e22ad3-b8b1-4fe2-a08a-45e5ba39df7d/events"
}
}
},
"links": {
"self": "http://example.lvis.io/api/v2/projects/a8e22ad3-b8b1-4fe2-a08a-45e5ba39df7d"
}
}
]
}