LIlivelike

Create Text Poll

Changed on
post/text-polls/

Request

  • Base URL
    https://cf-blast.livelikecdn.com/api/v1
  • URL
    https://cf-blast.livelikecdn.com/api/v1/text-polls/
  • Auth
    none required

Request body

questionstring required

The prompt or question for the prediction to be made

program_idstring required

ID of the program to create the prediction for

interactive_untilstring date

The UTC time that the widget will stop accepting interactions

playback_time_msinteger

Video playback time in milliseconds

timeoutstring required

A iso8601 duration hint for when a Widget should be timed out

custom_datastring

A free-form field used for custom behaviors

sponsor_idsstring[]

Links the sponsors with this Text Poll. Note that only valid sponsor_ids will be linked to a Text Poll.

Response

201

client_idstring
created_atstring
custom_dataunknown
engagement_countinteger
engagement_percentstring
idstring
impression_countinteger
impression_urlstring
interaction_urlstring
interactive_untilstring
kindstring
program_date_timeunknown
program_idstring
publish_delaystring
published_atstring
questionstring
rewards_urlunknown
schedule_urlstring
scheduled_atstring
statusstring
subscribe_channelstring
timeoutstring
translatable_fieldsstring[]
translationsobject
unique_impression_countinteger
playback_time_msunknown
urlstring
widget_interactions_url_templatestring

Example response

{
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "created_at": "2021-09-22T19:37:28.872727Z",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "engagement_count": 1,
  "engagement_percent": "1.000",
  "id": "fa8f2f08-b46d-40d9-9e97-2ef3451b8630",
  "impression_count": 1,
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/text-poll/fa8f2f08-b46d-40d9-9e97-2ef3451b8630/",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-polls/fa8f2f08-b46d-40d9-9e97-2ef3451b8630/interactions/",
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "kind": "text-poll",
  "options": [
    {
      "description": "Seattle Seahawks",
      "id": "f3362ee5-cf29-4a1b-81a5-c2d1bffe7e6a",
      "translatable_fields": [
        "description"
      ],
      "vote_count": 1,
      "vote_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-interactions/text-poll/fa8f2f08-b46d-40d9-9e97-2ef3451b8630/options/f3362ee5-cf29-4a1b-81a5-c2d1bffe7e6a/votes/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCaFM0a3Vsc0VRR1U2UjdaSjFhWmMtNEJvemRWRmdtd0RKTVhLLUpSdlAyb3pHRm1INFByYjVCeHpFUWdXeDZ4bV8tS19lc0dZeUFwbV84WlVHbWJwUjlPM1NHUT09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2MzIzNDAyNzB9.ACaQenHbmGEyuyMDXw3k3lpM9wKC7S_yWToAJQ9PADc/"
    }
  ],
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "publish_delay": "P0DT00H00M00S",
  "published_at": "2021-09-22T19:37:29.150275Z",
  "question": "Who do you think will win the game?",
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-polls/fa8f2f08-b46d-40d9-9e97-2ef3451b8630/schedule/",
  "scheduled_at": "2021-09-22T19:37:29.050817Z",
  "status": "published",
  "subscribe_channel": "program.widget.fa8f2f08-b46d-40d9-9e97-2ef3451b8630",
  "timeout": "P0DT00H00M30S",
  "translatable_fields": [
    "question"
  ],
  "unique_impression_count": 1,
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-polls/fa8f2f08-b46d-40d9-9e97-2ef3451b8630/",
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_poll_id=fa8f2f08-b46d-40d9-9e97-2ef3451b8630"
}

Changes