v24
Event History
LViS Event history feed contains Event data and all published Elements which have completed.

Files

Feed URL Format
Example
1
<static host>/events/<first two chars of event UUID>/<event UUID>/history.json
Copied!
1
Assuming uuid of c83756ea-8247-40bb-8f32-64400bcbea93 and static host of https://example.com
2
https://example.com/events/c8/c83756ea-8247-40bb-8f32-64400bcbea93/history.json
Copied!

Data

  • config contains an event data (object)
    • id event UUID(string)
    • name event name (string)
    • start_at start time as unix timestamp (integer)
    • start_at_iso start time in an ISO 8601 format (string)
    • end_at end time as unix timestamp (integer)
    • end_at_iso end time in an ISO 8601 format (string)
    • started started or already finished (boolean)
    • image_url URL to the image set in event settings (string)
    • custom_fields contains event level custom settings (object)
    • extra_time extra time of event
    • on_demand_time on demand of event
    • duration real event duration
    • original_duration original event duration
  • timeline contains objects with element data (array)
    • id element id (integer)
    • type name of a core element which this custom element built on top
    • content_type element content type (string)
    • duration element duration
    • published_at publish time as unix timestamp (integer)
    • published_at_iso publish time in an ISO 8601 format (string)
    • updated_at last time updated as unix timestamp (integer)
    • updated_at_iso last time updated in an ISO 8601 format (string)
    • duration duration in seconds (integer)
    • rating element's rating, when rating mode is enabled (float, precision depends on rating mode settings).
    • fixed is element has fixed duration (integer)
    • data processed data from enmasse
    • custom_fields contains element custom field values (object)
  • version file format version, currently 1 (integer)
custom_fields at event and element level contains field values as key-value object, where key is an custom field key from application spec.

Example

1
{
2
"timeline": [
3
{
4
"id": "7d9d03c7-a1db-4449-9432-3610dfd5f731",
5
"type": "rpoll",
6
"content_type": "rpoll-custom",
7
"published_at": 1555601671,
8
"published_at_iso": "2019-04-18T15:34:31Z",
9
"updated_at": 1555601673,
10
"updated_at_iso": "2019-04-18T15:34:33Z",
11
"data": {
12
"frame_type": "rpoll",
13
"id": 49116,
14
"state": "stopped",
15
"requires_validated_user": false,
16
"reveal_results_mode": "vote",
17
"results": [
18
{
19
"votes": 0,
20
"percentage": 0
21
},
22
{
23
"votes": 0,
24
"percentage": 0
25
}
26
],
27
"results_per_source": [
28
{
29
"source": "regular",
30
"voters": 0,
31
"results": [
32
{
33
"votes": 0,
34
"percentage": 0
35
},
36
{
37
"votes": 0,
38
"percentage": 0
39
}
40
]
41
}
42
],
43
"options": {
44
"en": [
45
{
46
"text": "Jack"
47
},
48
{
49
"text": "John"
50
}
51
],
52
"all": [
53
{
54
"text": "Jack"
55
},
56
{
57
"text": "John"
58
}
59
]
60
},
61
"question": {
62
"en": {
63
"text": "Jack or John?"
64
},
65
"all": {
66
"text": "Jack or John?"
67
}
68
},
69
"min_options_per_vote": 1,
70
"max_options_per_vote": 2,
71
"max_votes_per_user": 2,
72
"max_votes_per_option": 1
73
},
74
"custom_fields": {
75
"en": {
76
"text_during_poll": "Make your decision now...",
77
"text_after_poll": "Poll closed",
78
"text_after_answering": "Thanks for answering"
79
},
80
"all": {
81
"text_during_poll": "Make your decision now...",
82
"text_after_poll": "Poll closed",
83
"text_after_answering": "Thanks for answering"
84
}
85
},
86
"duration": 16,
87
"fixed": true
88
}
89
],
90
"config": {
91
"id": "8306b7fe-4ec8-4f1f-92cc-910a14ef5192",
92
"name": "Event Name",
93
"start_at": 1555598785,
94
"start_at_iso": "2019-04-18T14:46:25Z",
95
"end_at": 1555601687,
96
"end_at_iso": "2019-04-18T15:34:47Z",
97
"started": true,
98
"image_url": null,
99
"custom_fields": {
100
"en": {
101
"text_noncloneable_default": "text_noncloneable_default",
102
"text_cloneable_default": "text_cloneable_default",
103
"boolean": true,
104
"color": "rgba(23, 100, 240, 0.2)",
105
"float": 3.14159265
106
},
107
"all": {
108
"text_noncloneable_default": "text_noncloneable_default",
109
"text_cloneable_default": "text_cloneable_default",
110
"boolean": true,
111
"color": "rgba(23, 100, 240, 0.2)",
112
"float": 3.14159265
113
}
114
},
115
"extra_time": 63,
116
"on_demand_time": 0,
117
"duration": 2902,
118
"original_duration": 3600
119
},
120
"version": 2
121
}
Copied!
Last modified 2yr ago
Copy link