NAV Navigation
Shell HTTP

REST API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The backend services that power the LiveLike Producer CMS and mobile SDKs

Base URLs:

Terms of service Email: LiveLike Web: LiveLike

Authentication

Applications

Fetch an application

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/ \
  -H 'Accept: application/json'

GET https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /applications/{client_id}/

Parameters

Name In Type Required Description
client_id path string true The application Client ID

Example responses

200 Response

{
  "client_id": "yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "url": "https://cf-blast.livelikecdn.com/api/v1/applications/yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz/",
  "name": "My Sports Application",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/cd4fba9c-78cc-43c2-9832-f3860d2bcb3b.png",
  "pubnub_subscribe_key": "sub-c-016eb444-d156-12e8-b5de-7a9dbb77e127",
  "sendbird_api_endpoint": "https://api-us-2.sendbird.com/",
  "sendbird_app_id": "A2F2FF80-C254-4BE2-8F1D-F629C7568662",
  "mixpanel_token": "5d822693e5be77b28b2716f2c0fbddf5",
  "media_url": "https://cf-blast.livelikecdn.com/api/v1/media/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "sessions_url": false,
  "programs_url": "https://cf-blast.livelikecdn.com/api/v1/programs/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "program_detail_url_template": "https://cf-blast.livelikecdn.com/api/v1/programs/{program_id}/"
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK Success Application
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Create an application profile

Code samples

# You can also use wget
curl -X POST https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/profile/ \
  -H 'Accept: application/json'

POST https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/profile/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

POST /applications/{client_id}/profile/

An application profile is required for users to participate and interact with the application.

Parameters

Name In Type Required Description
client_id path string true The application Client ID

Example responses

201 Response

{
  "id": "c343175c-9885-43cc-b6f7-91163dcd7b3b",
  "nickname": "Dunk Genius",
  "widgets_enabled": true,
  "chat_enabled": true,
  "access_token": "0tv_eKDyPM5CqZdU5rs4EDtOjFADfPkMm9W2LQdsvdv-Ji39K-4NVw"
}

Responses

Status Meaning Description Schema
201 Created The application profile was created. CreateApplicationProfile

Fetch an application profile

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/profile/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://cf-blast.livelikecdn.com/api/v1/applications/{client_id}/profile/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /applications/{client_id}/profile/

Fetch the application profile associated with the OAuth2 access token. operationId: fetch_application_profile

Parameters

Name In Type Required Description
client_id path string true The application Client ID

Example responses

200 Response

{
  "id": "c343175c-9885-43cc-b6f7-91163dcd7b3b",
  "nickname": "Dunk Genius",
  "widgets_enabled": true,
  "chat_enabled": true
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK Success ApplicationProfile
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Media

List application media

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/media/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://cf-blast.livelikecdn.com/api/v1/media/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /media/

Application media items are files such as images or videos.

Parameters

Name In Type Required Description
client_id query string true The application Client ID
ordering query string false How to order the results
description query string false Search media items by description
tags query string false Search media items by tag

Enumerated Values

Parameter Value
ordering created_at
ordering -created_at

Example responses

200 Response

[
  {
    "id": "8e516314-35b9-4f38-b359-8a943306e3ab",
    "url": "https://cf-blast.livelikecdn.com/api/v1/media/8e516314-35b9-4f38-b359-8a943306e3ab/",
    "created_at": "2019-07-12T18:22:58Z",
    "description": "LeBron James vs. Kevin Durant",
    "file": "https://cf-blast-storage.livelikecdn.com/assets/46f212cc-01f1-4a21-84e8-4335433f9fc3.png",
    "mimetype": "image/png",
    "tags": [
      "lakers",
      "warriors"
    ]
  }
]

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK Success Inline
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Media] false none none
» id string(uuid) false none The media ID
» url string(uri) false none The media API URL
» created_at string(date-time) false none When this media was created
» description string false none A description of this media
» file string(uri) false none The URL to the media asset
» mimetype string false none The media asset mimetype
» tags [string] false none A list of tags associated with this media

Create a media item

Code samples

# You can also use wget
curl -X POST https://cf-blast.livelikecdn.com/api/v1/media/ \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://cf-blast.livelikecdn.com/api/v1/media/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: multipart/form-data
Accept: application/json

POST /media/

Body parameter

client_id: yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz
file: string
description: LeBron James vs. Kevin Durant
tags:
  - lakers
  - warriors

Parameters

Name In Type Required Description
body body CreateMedia false none

Example responses

201 Response

[
  {
    "id": "8e516314-35b9-4f38-b359-8a943306e3ab",
    "url": "https://cf-blast.livelikecdn.com/api/v1/media/8e516314-35b9-4f38-b359-8a943306e3ab/",
    "created_at": "2019-07-12T18:22:58Z",
    "description": "LeBron James vs. Kevin Durant",
    "file": "https://cf-blast-storage.livelikecdn.com/assets/46f212cc-01f1-4a21-84e8-4335433f9fc3.png",
    "mimetype": "image/png",
    "tags": [
      "lakers",
      "warriors"
    ]
  }
]

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
201 Created The media item was created. Inline
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
anonymous [Media] false none none
» id string(uuid) false none The media ID
» url string(uri) false none The media API URL
» created_at string(date-time) false none When this media was created
» description string false none A description of this media
» file string(uri) false none The URL to the media asset
» mimetype string false none The media asset mimetype
» tags [string] false none A list of tags associated with this media

Fetch a single media item

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/media/{id}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://cf-blast.livelikecdn.com/api/v1/media/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /media/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The media item ID

Example responses

200 Response

{
  "id": "8e516314-35b9-4f38-b359-8a943306e3ab",
  "url": "https://cf-blast.livelikecdn.com/api/v1/media/8e516314-35b9-4f38-b359-8a943306e3ab/",
  "created_at": "2019-07-12T18:22:58Z",
  "description": "LeBron James vs. Kevin Durant",
  "file": "https://cf-blast-storage.livelikecdn.com/assets/46f212cc-01f1-4a21-84e8-4335433f9fc3.png",
  "mimetype": "image/png",
  "tags": [
    "lakers",
    "warriors"
  ]
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK Success Media
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Update a media item

Code samples

# You can also use wget
curl -X PATCH https://cf-blast.livelikecdn.com/api/v1/media/{id}/ \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://cf-blast.livelikecdn.com/api/v1/media/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: multipart/form-data
Accept: application/json

PATCH /media/{id}/

Body parameter

file: string
description: LeBron James vs. Kevin Durant
tags:
  - lakers
  - warriors

Parameters

Name In Type Required Description
id path string(uuid) true The media item ID
body body UpdateMedia false none

Example responses

200 Response

{
  "id": "8e516314-35b9-4f38-b359-8a943306e3ab",
  "url": "https://cf-blast.livelikecdn.com/api/v1/media/8e516314-35b9-4f38-b359-8a943306e3ab/",
  "created_at": "2019-07-12T18:22:58Z",
  "description": "LeBron James vs. Kevin Durant",
  "file": "https://cf-blast-storage.livelikecdn.com/assets/46f212cc-01f1-4a21-84e8-4335433f9fc3.png",
  "mimetype": "image/png",
  "tags": [
    "lakers",
    "warriors"
  ]
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK The media item was updated. Media
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Delete a media item

Code samples

# You can also use wget
curl -X DELETE https://cf-blast.livelikecdn.com/api/v1/media/{id}/ \
  -H 'Authorization: Bearer {access-token}'

DELETE https://cf-blast.livelikecdn.com/api/v1/media/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com

DELETE /media/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The media item ID

Responses

Status Meaning Description Schema
204 No Content The media item was deleted. None

Programs

List programs for an application

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/programs/?client_id=string \
  -H 'Accept: application/json'

GET https://cf-blast.livelikecdn.com/api/v1/programs/?client_id=string HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /programs/

Parameters

Name In Type Required Description
client_id query string true The application client ID

Example responses

200 Response

[
  {
    "id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
    "url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/",
    "title": "Lakers vs. Warriors",
    "created_at": "2019-07-12T18:22:58Z",
    "scheduled_at": "2019-12-04T17:00:05Z",
    "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/widgets/",
    "widgets_enabled": true,
    "chat_enabled": true,
    "subscribe_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
    "sendbird_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
    "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/queue-order/",
    "widget_count": 0,
    "status": "future",
    "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/sync-sessions/",
    "sync_channel": "sync_4133e8f8_91fb_4c5f_874a_75f5962cb143",
    "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/statistics/active-sessions/",
    "statistics_channel": "statistics_4133e8f8_91fb_4c5f_874a_75f5962cb143",
    "current_active_session_count": 0
  }
]

Responses

Status Meaning Description Schema
200 OK Success Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Program] false none none
» id string(uuid) false none The program ID
» url string(uri) false none The program API URL
» title string false none The program title
» created_at string(date-time) false none When this program was created
» scheduled_at string(date-time) false none When this program is scheduled to start
» widgets_url string(uri) false none URL to the list of widgets published for this program
» widgets_enabled boolean false none Whether widgets are enabled for this program
» chat_enabled boolean false none Whether chat is enabled for this program
» subscribe_channel string false none The program's PubNub channel
» sendbird_channel string false none The program's SendBird chat channel
» queue_order_url string(uri) false none The URL to re-order queued widgets for this program
» widget_count integer(int32) false none The number of widgets published for this program
» status string false none The program status
» sync_sessions_url string(uri) false none The URL to establish and connect to a video sync session for this program
» sync_channel string|null false none The PubNub channel to publish video sync information for this program
» active_sessions_statistics_url string(uri) false none The URL to fetch active user/session statistics for this program
» statistics_channel string false none The PubNub channel for active user/session statistics
» current_active_session_count integer(int32) false none The current number of users/sessions active in this program

Enumerated Values

Property Value
status past
status live
status future

Create a program

Code samples

# You can also use wget
curl -X POST https://cf-blast.livelikecdn.com/api/v1/programs/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://cf-blast.livelikecdn.com/api/v1/programs/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: application/json
Accept: application/json

POST /programs/

Body parameter

{
  "client_id": "yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "title": "Lakers vs. Warriors",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_enabled": true,
  "chat_enabled": true
}

Parameters

Name In Type Required Description
body body CreateProgram false none

Example responses

201 Response

{
  "id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/",
  "title": "Lakers vs. Warriors",
  "created_at": "2019-07-12T18:22:58Z",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "sendbird_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/queue-order/",
  "widget_count": 0,
  "status": "future",
  "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/sync-sessions/",
  "sync_channel": "sync_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/statistics/active-sessions/",
  "statistics_channel": "statistics_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "current_active_session_count": 0
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
201 Created The program was created. Program
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Fetch a single program

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ \
  -H 'Accept: application/json'

GET https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /programs/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The program ID

Example responses

200 Response

{
  "id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/",
  "title": "Lakers vs. Warriors",
  "created_at": "2019-07-12T18:22:58Z",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "sendbird_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/queue-order/",
  "widget_count": 0,
  "status": "future",
  "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/sync-sessions/",
  "sync_channel": "sync_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/statistics/active-sessions/",
  "statistics_channel": "statistics_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "current_active_session_count": 0
}

Responses

Status Meaning Description Schema
200 OK Success Program

Update a program

Code samples

# You can also use wget
curl -X PATCH https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: application/json
Accept: application/json

PATCH /programs/{id}/

Body parameter

{
  "title": "Lakers vs. Warriors",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_enabled": true,
  "chat_enabled": true
}

Parameters

Name In Type Required Description
id path string(uuid) true The program ID
body body UpdateProgram false none

Example responses

200 Response

{
  "id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/",
  "title": "Lakers vs. Warriors",
  "created_at": "2019-07-12T18:22:58Z",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "sendbird_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/queue-order/",
  "widget_count": 0,
  "status": "future",
  "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/sync-sessions/",
  "sync_channel": "sync_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/statistics/active-sessions/",
  "statistics_channel": "statistics_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "current_active_session_count": 0
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK The program was updated. Program
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Delete a program

Code samples

# You can also use wget
curl -X DELETE https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://cf-blast.livelikecdn.com/api/v1/programs/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

DELETE /programs/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The program ID

Example responses

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
204 No Content The program was deleted. None
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Publishing widgets

Publish a widget

Code samples

# You can also use wget
curl -X PUT https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: application/json
Accept: application/json

PUT /{widget_kind}/{widget_id}/schedule/

Body parameter

{
  "publish_delay": "P0DT00H00M00S",
  "program_date_time": "2019-07-12T18:22:58Z"
}

Parameters

Name In Type Required Description
body body UpdateScheduleWidget false none

Example responses

200 Response

{
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z"
}

Responses

Status Meaning Description Schema
200 OK Success ScheduleWidget

Fetch a widget's published status

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /{widget_kind}/{widget_id}/schedule/

Example responses

200 Response

{
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z"
}

Responses

Status Meaning Description Schema
200 OK Success ScheduleWidget

Un-schedule a widget from publishing

Code samples

# You can also use wget
curl -X DELETE https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ \
  -H 'Authorization: Bearer {access-token}'

DELETE https://cf-blast.livelikecdn.com/api/v1/{widget_kind}/{widget_id}/schedule/ HTTP/1.1
Host: cf-blast.livelikecdn.com

DELETE /{widget_kind}/{widget_id}/schedule/

Responses

Status Meaning Description Schema
204 No Content Success None

Alerts

Create an alert

Code samples

# You can also use wget
curl -X POST https://cf-blast.livelikecdn.com/api/v1/alerts/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://cf-blast.livelikecdn.com/api/v1/alerts/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: application/json
Accept: application/json

POST /alerts/

Body parameter

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!"
}

Parameters

Name In Type Required Description
body body CreateAlert false none

Example responses

201 Response

[
  {
    "timeout": "P0DT00H00M30S",
    "title": "Big Game!",
    "text": "This is going to be a really big game today!  Get pumped!",
    "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
    "link_url": "https://livelike.com/",
    "link_label": "LiveLike!",
    "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
    "id": "string",
    "url": "http://example.com",
    "created_at": "2019-07-12T18:22:58Z",
    "status": "published",
    "published_at": "2019-06-26T21:32:17Z",
    "scheduled_at": "2019-06-26T21:32:17Z",
    "schedule_url": "http://example.com",
    "kind": "alert",
    "subscribe_channel": "string",
    "impression_url": "http://example.com",
    "impression_count": 0,
    "unique_impression_count": 0,
    "engagement_count": 0,
    "engagement_percent": "0.780"
  }
]

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
201 Created Created Inline
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Status Code 201

Name Type Required Restrictions Description
anonymous [allOf] false none none

allOf

Name Type Required Restrictions Description
» anonymous any false none none

allOf

Name Type Required Restrictions Description
»» anonymous object false none none
»»» timeout string|null false none The amount of time this widget should be active

and

Name Type Required Restrictions Description
»» anonymous object false none none
»»» title string false none The alert title
»»» text string false none The alert text
»»» image_url string(uri) false none Optional URL of an image
»»» link_url string(uri) false none Option link URL
»»» link_label string false none Label for the link_url

and

Name Type Required Restrictions Description
»» anonymous any false none none

allOf

Name Type Required Restrictions Description
»»» anonymous any false none none

allOf

Name Type Required Restrictions Description
»»»» anonymous object false none none

and

Name Type Required Restrictions Description
»»»» anonymous object false none none
»»»»» program_id string(uuid) false none The associated program ID

and

Name Type Required Restrictions Description
»»»» anonymous object false none none
»»»»» id string(uuid) false none The widget ID
»»»»» url string(uri) false none The widget API URL
»»»»» created_at string(date-time) false none When this widget was created
»»»»» status string false none The widget status
»»»»» published_at string(date-time)|null false none When this widget was published
»»»»» scheduled_at string(date-time)|null false none When this widget is scheduled to be published
»»»»» schedule_url string(uri) false none The URL to schedule publishing of this widget
»»»»» kind string false none The widget kind
»»»»» subscribe_channel string false none The PubNub channel for this widget
»»»»» impression_url string(uri) false none The URL to record impressions of this widget
»»»»» impression_count integer(int32) false none The total number of impressions of this widget
»»»»» unique_impression_count integer(int32) false none The number of unique impressions of this widget
»»»»» engagement_count integer(int32) false none The total number of engagements with this widget
»»»»» engagement_percent string false none The percentage of unique viewers of this widget that engaged with it

and

Name Type Required Restrictions Description
»»»» anonymous object false none none
»»»»» kind string false none The widget kind

Enumerated Values

Property Value
status pending
status scheduled
status inflight
status published
kind alert
kind cheer-meter
kind emoji-poll
kind emoji-slider
kind image-poll
kind image-prediction
kind image-prediction-follow-up
kind image-quiz
kind text-poll
kind text-prediction
kind text-prediction-follow-up
kind text-quiz
kind twitter-spotlight
kind alert

Fetch a single alert widget

Code samples

# You can also use wget
curl -X GET https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ \
  -H 'Accept: application/json'

GET https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

GET /alerts/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The alert widget ID

Example responses

200 Response

{
  "timeout": "P0DT00H00M30S",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "alert",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Responses

Status Meaning Description Schema
200 OK Success Alert

Update an alert

Code samples

# You can also use wget
curl -X PATCH https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Content-Type: application/json
Accept: application/json

PATCH /alerts/{id}/

Body parameter

{
  "timeout": "P0DT00H00M30S",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!"
}

Parameters

Name In Type Required Description
id path string(uuid) true The alert widget ID
body body UpdateAlert false none

Example responses

200 Response

{
  "timeout": "P0DT00H00M30S",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "alert",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
200 OK The alert widget was updated Alert
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Delete an alert

Code samples

# You can also use wget
curl -X DELETE https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://cf-blast.livelikecdn.com/api/v1/alerts/{id}/ HTTP/1.1
Host: cf-blast.livelikecdn.com
Accept: application/json

DELETE /alerts/{id}/

Parameters

Name In Type Required Description
id path string(uuid) true The alert widget ID

Example responses

403 Response

{
  "detail": "Authentication credentials were invalid or not provided."
}

Responses

Status Meaning Description Schema
204 No Content The alert widget was deleted None
403 Forbidden Authentication credentials were invalid or not provided Inline

Response Schema

Schemas

PagingPage

{
  "next": "http://example.com",
  "previous": "http://example.com",
  "count": 0,
  "results": [
    {}
  ]
}

Properties

Name Type Required Restrictions Description
next string(uri)|null false none The next page URL
previous string(uri)|null false none The previous page URL
count integer(int32) false none The total number of items across all pages
results [object] false none The list of items in the current page

Application

{
  "client_id": "yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "url": "https://cf-blast.livelikecdn.com/api/v1/applications/yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz/",
  "name": "My Sports Application",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/cd4fba9c-78cc-43c2-9832-f3860d2bcb3b.png",
  "pubnub_subscribe_key": "sub-c-016eb444-d156-12e8-b5de-7a9dbb77e127",
  "sendbird_api_endpoint": "https://api-us-2.sendbird.com/",
  "sendbird_app_id": "A2F2FF80-C254-4BE2-8F1D-F629C7568662",
  "mixpanel_token": "5d822693e5be77b28b2716f2c0fbddf5",
  "media_url": "https://cf-blast.livelikecdn.com/api/v1/media/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "sticker_packs_url": "https://cf-blast.livelikecdn.com/api/v1/sticker-packs/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "sessions_url": false,
  "programs_url": "https://cf-blast.livelikecdn.com/api/v1/programs/?client_id=yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "program_detail_url_template": "https://cf-blast.livelikecdn.com/api/v1/programs/{program_id}/"
}

Properties

Name Type Required Restrictions Description
client_id string false none The application Client ID
url string(uri) false none The application API URL
name string false none The name of this application
image_url string(uri) false none The application image
pubnub_subscribe_key string|null false none The PubNub subscribe key for this application
sendbird_api_endpoint string(uri) false none The SendBird API endpoint for this application
sendbird_app_id string|null false none The SendBird App ID for this application
mixpanel_token string|null false none The Mixpanel token for this application
media_url string(uri) false none The API URL to the media for this application
sticker_packs_url string(uri) false none The API URL to the sticker packs for this application
sessions_url string(uri) false none The API URL to create user sessions for this application
programs_url string(uri) false none The API URL to the programs for this application
program_detail_url_template string(uri) false none The API URL template to fetch a single program for this application

ApplicationProfile

{
  "id": "c343175c-9885-43cc-b6f7-91163dcd7b3b",
  "nickname": "Dunk Genius",
  "widgets_enabled": true,
  "chat_enabled": true
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none Application profile ID
nickname string false none Chat nickname
widgets_enabled boolean false none Whether widgets are enabled for this user
chat_enabled boolean false none Whether chat is enabled for this user

CreateApplicationProfile

{
  "id": "c343175c-9885-43cc-b6f7-91163dcd7b3b",
  "nickname": "Dunk Genius",
  "widgets_enabled": true,
  "chat_enabled": true,
  "access_token": "0tv_eKDyPM5CqZdU5rs4EDtOjFADfPkMm9W2LQdsvdv-Ji39K-4NVw"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous ApplicationProfile false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» access_token string false none OAuth2 access token associated with this profile

Media

{
  "id": "8e516314-35b9-4f38-b359-8a943306e3ab",
  "url": "https://cf-blast.livelikecdn.com/api/v1/media/8e516314-35b9-4f38-b359-8a943306e3ab/",
  "created_at": "2019-07-12T18:22:58Z",
  "description": "LeBron James vs. Kevin Durant",
  "file": "https://cf-blast-storage.livelikecdn.com/assets/46f212cc-01f1-4a21-84e8-4335433f9fc3.png",
  "mimetype": "image/png",
  "tags": [
    "lakers",
    "warriors"
  ]
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none The media ID
url string(uri) false none The media API URL
created_at string(date-time) false none When this media was created
description string false none A description of this media
file string(uri) false none The URL to the media asset
mimetype string false none The media asset mimetype
tags [string] false none A list of tags associated with this media

CreateMedia

{
  "client_id": "yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "file": "string",
  "description": "LeBron James vs. Kevin Durant",
  "tags": [
    "lakers",
    "warriors"
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous object false none none
» client_id string true none The application Client ID
» file string(binary) true none A file to upload

and

Name Type Required Restrictions Description
anonymous UpdateMedia false none none

UpdateMedia

{
  "file": "string",
  "description": "LeBron James vs. Kevin Durant",
  "tags": [
    "lakers",
    "warriors"
  ]
}

Properties

Name Type Required Restrictions Description
file string(binary) false none A file to upload
description string false none A description of the media
tags [string] false none One or more tags to associate with the media

Program

{
  "id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/",
  "title": "Lakers vs. Warriors",
  "created_at": "2019-07-12T18:22:58Z",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/widgets/",
  "widgets_enabled": true,
  "chat_enabled": true,
  "subscribe_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "sendbird_channel": "program_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "queue_order_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/queue-order/",
  "widget_count": 0,
  "status": "future",
  "sync_sessions_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/sync-sessions/",
  "sync_channel": "sync_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "active_sessions_statistics_url": "https://cf-blast.livelikecdn.com/api/v1/programs/4133e8f8-91fb-4c5f-874a-75f5962cb143/statistics/active-sessions/",
  "statistics_channel": "statistics_4133e8f8_91fb_4c5f_874a_75f5962cb143",
  "current_active_session_count": 0
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none The program ID
url string(uri) false none The program API URL
title string false none The program title
created_at string(date-time) false none When this program was created
scheduled_at string(date-time) false none When this program is scheduled to start
widgets_url string(uri) false none URL to the list of widgets published for this program
widgets_enabled boolean false none Whether widgets are enabled for this program
chat_enabled boolean false none Whether chat is enabled for this program
subscribe_channel string false none The program's PubNub channel
sendbird_channel string false none The program's SendBird chat channel
queue_order_url string(uri) false none The URL to re-order queued widgets for this program
widget_count integer(int32) false none The number of widgets published for this program
status string false none The program status
sync_sessions_url string(uri) false none The URL to establish and connect to a video sync session for this program
sync_channel string|null false none The PubNub channel to publish video sync information for this program
active_sessions_statistics_url string(uri) false none The URL to fetch active user/session statistics for this program
statistics_channel string false none The PubNub channel for active user/session statistics
current_active_session_count integer(int32) false none The current number of users/sessions active in this program

Enumerated Values

Property Value
status past
status live
status future

CreateProgram

{
  "client_id": "yM6Rjb0Pn8umVj2t8lkcRwNohvYDEHHhMthdKbAz",
  "title": "Lakers vs. Warriors",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_enabled": true,
  "chat_enabled": true
}

Properties

allOf

Name Type Required Restrictions Description
anonymous object false none none
» client_id string true none The application Client ID

and

Name Type Required Restrictions Description
anonymous UpdateProgram false none none

UpdateProgram

{
  "title": "Lakers vs. Warriors",
  "scheduled_at": "2019-12-04T17:00:05Z",
  "widgets_enabled": true,
  "chat_enabled": true
}

Properties

Name Type Required Restrictions Description
title string false none The program title
scheduled_at string(date-time) false none When this program in scheduled to start
widgets_enabled boolean false none Whether widgets are enabled for this program
chat_enabled boolean false none Whether chat is enabled for this program

UpdateScheduleWidget

{
  "publish_delay": "P0DT00H00M00S",
  "program_date_time": "2019-07-12T18:22:58Z"
}

Properties

Name Type Required Restrictions Description
publish_delay string|null false none The amount of time to wait until the widget is published
program_date_time string(date-time)|null false none When this widget should be displayed in the video stream. This value should correspond to the EXT-X-PROGRAM-DATE-TIME in the video stream manifest.

ScheduleWidget

{
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous UpdateScheduleFutureWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» status string false none The widget status
» published_at string(date-time)|null false none When this widget was published
» scheduled_at string(date-time)|null false none When this widget is scheduled to be published

Enumerated Values

Property Value
status pending
status scheduled
status inflight
status published

BaseCreateWidget

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseUpdateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» program_id string(uuid) false none The associated program ID

BaseUpdateWidget

{
  "timeout": "P0DT00H00M30S"
}

Properties

Name Type Required Restrictions Description
timeout string|null false none The amount of time this widget should be active

BaseWidget

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "alert",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseCreateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» id string(uuid) false none The widget ID
» url string(uri) false none The widget API URL
» created_at string(date-time) false none When this widget was created
» status string false none The widget status
» published_at string(date-time)|null false none When this widget was published
» scheduled_at string(date-time)|null false none When this widget is scheduled to be published
» schedule_url string(uri) false none The URL to schedule publishing of this widget
» kind string false none The widget kind
» subscribe_channel string false none The PubNub channel for this widget
» impression_url string(uri) false none The URL to record impressions of this widget
» impression_count integer(int32) false none The total number of impressions of this widget
» unique_impression_count integer(int32) false none The number of unique impressions of this widget
» engagement_count integer(int32) false none The total number of engagements with this widget
» engagement_percent string false none The percentage of unique viewers of this widget that engaged with it

Enumerated Values

Property Value
status pending
status scheduled
status inflight
status published
kind alert
kind cheer-meter
kind emoji-poll
kind emoji-slider
kind image-poll
kind image-prediction
kind image-prediction-follow-up
kind image-quiz
kind text-poll
kind text-prediction
kind text-prediction-follow-up
kind text-quiz
kind twitter-spotlight

CreateAlert

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseCreateWidget false none none

and

Name Type Required Restrictions Description
anonymous UpdateAlert false none none

UpdateAlert

{
  "timeout": "P0DT00H00M30S",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseUpdateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» title string false none The alert title
» text string false none The alert text
» image_url string(uri) false none Optional URL of an image
» link_url string(uri) false none Option link URL
» link_label string false none Label for the link_url

Alert

{
  "timeout": "P0DT00H00M30S",
  "title": "Big Game!",
  "text": "This is going to be a really big game today!  Get pumped!",
  "image_url": "https://cf-blast-storage.livelikecdn.com/assets/e5c93746-77d1-4d67-b913-ead5634e7d71.jpg",
  "link_url": "https://livelike.com/",
  "link_label": "LiveLike!",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "alert",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous UpdateAlert false none none

and

Name Type Required Restrictions Description
anonymous BaseWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» kind string false none The widget kind

Enumerated Values

Property Value
kind alert

Vote

{
  "id": "string",
  "url": "http://example.com",
  "option_id": "string"
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none The vote ID
url string(uri) false none The vote URL
option_id string(uuid) false none The ID of the option this vote is for

BaseOption

{
  "id": "string",
  "vote_count": 0,
  "vote_url": "http://example.com"
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none The option ID
vote_count integer(int32) false none The total number of votes for this option
vote_url string(uri) false none The URL to create a vote for this option

CreateUpdateTextOption

{
  "description": "string"
}

Properties

Name Type Required Restrictions Description
description string false none The option description

CreateUpdateImageOption

{
  "description": "string",
  "image_url": "http://example.com"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous CreateUpdateTextOption false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» image_url string(uri) false none The option image URL

ImageOption

{
  "id": "string",
  "vote_count": 0,
  "vote_url": "http://example.com",
  "description": "string",
  "image_url": "http://example.com"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseOption false none none

and

Name Type Required Restrictions Description
anonymous CreateUpdateImageOption false none none

TextOption

{
  "id": "string",
  "vote_count": 0,
  "vote_url": "http://example.com",
  "description": "string"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseOption false none none

and

Name Type Required Restrictions Description
anonymous CreateUpdateTextOption false none none

CreateTextPoll

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "question": "string",
  "options": [
    {
      "description": "string"
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseCreateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» question string false none The poll question
» options [CreateUpdateTextOption] false none The poll options

UpdateTextPoll

{
  "timeout": "P0DT00H00M30S",
  "question": "string",
  "options": [
    {
      "description": "string"
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseUpdateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» question string false none The poll question
» options [CreateUpdateTextOption] false none The poll options

TextPoll

{
  "timeout": "P0DT00H00M30S",
  "question": "string",
  "options": [
    {
      "description": "string"
    }
  ],
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "text-poll",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous UpdateTextPoll false none none

and

Name Type Required Restrictions Description
anonymous BaseWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» kind string false none The widget kind

Enumerated Values

Property Value
kind text-poll

CreateImagePoll

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "question": "string",
  "options": [
    {
      "description": "string",
      "image_url": "http://example.com"
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseCreateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» question string false none The poll question
» options [CreateUpdateImageOption] false none The poll options

UpdateImagePoll

{
  "timeout": "P0DT00H00M30S",
  "question": "string",
  "options": [
    {
      "description": "string",
      "image_url": "http://example.com"
    }
  ]
}

Properties

allOf

Name Type Required Restrictions Description
anonymous BaseUpdateWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» question string false none The poll question
» options [CreateUpdateImageOption] false none The poll options

ImagePoll

{
  "timeout": "P0DT00H00M30S",
  "question": "string",
  "options": [
    {
      "description": "string",
      "image_url": "http://example.com"
    }
  ],
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "image-poll",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Properties

allOf

Name Type Required Restrictions Description
anonymous UpdateImagePoll false none none

and

Name Type Required Restrictions Description
anonymous BaseWidget false none none

and

Name Type Required Restrictions Description
anonymous object false none none
» kind string false none The widget kind

Enumerated Values

Property Value
kind image-poll

BasePredictionFollowUp

{
  "timeout": "P0DT00H00M30S",
  "program_id": "4133e8f8-91fb-4c5f-874a-75f5962cb143",
  "id": "string",
  "url": "http://example.com",
  "created_at": "2019-07-12T18:22:58Z",
  "status": "published",
  "published_at": "2019-06-26T21:32:17Z",
  "scheduled_at": "2019-06-26T21:32:17Z",
  "schedule_url": "http://example.com",
  "kind": "alert",
  "subscribe_channel": "string",
  "impression_url": "http://example.com",
  "impression_count": 0,
  "unique_impression_count": 0,
  "engagement_count": 0,
  "engagement_percent": "0.780"
}

Properties

None