TV & Big Screen Graphics

The Interaction Cloud provides dynamic data for example poll results, which can easily be fed into TV Graphics or other systems. This data is provided via the server-side Control API. If you have previously used feeds, these are still available but no longer supported. Here is the guide on Migrating private feeds to Control API​
Overview
Your graphics system will need to make an HTTP request using a token, and then parse the JSON data that is returned in order to locate the poll data and display it on-screen. Instructions on getting that token are below.
The platform's information hierarchy is Project > Event > Element, whereby Project is your application, Event is the live event, and Element is Poll, Quiz or another element from where you want to pull the data.
If you know the unique Element ID for a poll you can make this request in one go. This data can be retrieved from Studio and passed from content producer to TV graphics operator for manual configuration.
However, if want to make your request more dynamic, you can provide a Project ID query the list of events in a project, then drill down into an event, and traverse all elements to identify the one you want.
However, there is a way to elect only certain polls to provide their data, and then using the "filter" attribute in the API you can retrieve a sub-selection of poll data. This is useful if your timeline is full of content that is not relevant to on-screen graphics.
Getting your access token
Access is authenticated using an oAuth 2.0 Bearer token. The Bearer token is linked to a Studio user account and can be retracted at any time by the user. The Bearer token needs to be passed along with the request in the Authorization HTTP header.
Your Bearer token is available from the API CREDENTIALS tab on the Profile Info page, accessed via the drop-down shown below:
Select Profile Info from the Account Menu
On the API CREDENTIALS tab you can generate/regenerate/revoke the token. The token provides the same level of access via the Control API as the user has via Studio UI.
Fetching all published Elements
Response
1
curl -H "Content-type: application/json" -H "Authorization: Bearer Yx3_Pnrdy4A46tdvfMrKEEQuczDyAUyh"  "https://environment.lvis.io/api/v2/projects/b9435779-ca90-4264-ad0b-745e22c6a9fc/events?filter[state]=current,past&include=stats"
Copied!
1
{
2
  "data": [
3
    {
4
      "id": "df60a378-f9df-4e13-94d1-a2913fa368b6",
5
      "type": "events",
6
      "attributes": {
7
        "name": "Event name",
8
        "duration": 3600,
9
        "original_duration": 3600,
10
        "start_mode": "clock",
11
        "repeat": false,
12
        "repeat_in": null,
13
        "live_stats_uuid": null,
14
        "on_demand_duration": null,
15
        "extra_time_duration": 0,
16
        "start_at": 1538399247,
17
        "start_at_iso": "2018-10-01T13:07:27Z",
18
        "end_at": 1538402847,
19
        "end_at_iso": "2018-10-01T14:07:27Z",
20
        "settings": [],
21
        "state": "past"
22
      },
23
      "relationships": {
24
        "elements": {
25
          "links": {
26
            "related": "https://environment.lvis.io/api/v2/events/df60a378-f9df-4e13-94d1-a2913fa368b6/elements"
27
          }
28
        },
29
        "stats": {
30
          "data": {
31
            "id": "df60a378-f9df-4e13-94d1-a2913fa368b6",
32
            "type": "stats"
33
          }
34
        },
35
        "project": {
36
          "data": {
37
            "id": "b9435779-ca90-4264-ad0b-745e22c6a9fc",
38
            "type": "projects"
39
          }
40
        }
41
      },
42
      "links": {
43
        "self": "https://environment.lvis.io/api/v2/events/df60a378-f9df-4e13-94d1-a2913fa368b6"
44
      }
45
    },
46
  ],
47
  "included": [
48
    {
49
      "id": "df60a378-f9df-4e13-94d1-a2913fa368b6",
50
      "type": "stats",
51
      "attributes": {
52
        "interactions": 0,
53
        "peak_concurrency": 0,
54
        "current_concurrency": 0,
55
        "unique_users": 0,
56
        "average_session_length": 0,
57
        "elements_count": 3
58
      }
59
    },
60
  ],
61
  "links": {
62
    "prev": "https://environment.lvis.io/api/v2/projects/b9435779-ca90-4264-ad0b-745e22c6a9fc/events?filter[state]=current%2Cpast&page[count]=20&page[cursor]=eyJmcm9tIjoxNTM4Mzk5MjQ3MDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6IjI1IiwiZm9yd2FyZCI6ZmFsc2V9",
63
    "next": "https://environment.lvis.io/api/v2/projects/b9435779-ca90-4264-ad0b-745e22c6a9fc/events?filter[state]=current%2Cpast&page[count]=20&page[cursor]=eyJmcm9tIjoxNTYwNDk1NzM0MDAwLCJvcmRlciI6InN0YXJ0X3RpbWUiLCJpZCI6IjQwNTEiLCJmb3J3YXJkIjp0cnVlfQ%3D%3D"
64
  }
65
}
Copied!
Query param "filter[state]" is required and only future, current, on_demand, past states are allowed and must be separated by comma.
The output is a JSON document adhering to the JSONAPI specification. There are also a number of existing libraries for different languages.
If you have used the feeds before, here is the guide Migrating private feeds to Control API​

External data source

Next - DEVELOPER GUIDES

Working with Gamify

Last modified 1yr ago

Copy link

Contents

Overview

Getting your access token