v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Create Image Poll

post/image-polls/

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

Response

201

client_idstring

created_atstring

{"stackTrail":"paths:/image-polls/:post:responses:201:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}

engagement_countinteger

engagement_percentstring

idstring

impression_countinteger

impression_urlstring

interaction_urlstring

interactive_untilstring

kindstring

{"stackTrail":"paths:/image-polls/:post:responses:201:content:application/json:schema:properties:program_date_time","oasType":"schema","type":"unknown"}

program_idstring

publish_delaystring

published_atstring

questionstring

{"stackTrail":"paths:/image-polls/:post:responses:201:content:application/json:schema:properties:rewards_url","oasType":"schema","type":"unknown"}

schedule_urlstring

scheduled_atstring

statusstring

subscribe_channelstring

timeoutstring

translatable_fieldsstring[]

translationsobject

unique_impression_countinteger

urlstring

widget_interactions_url_templatestring

Example response

{
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "created_at": "2021-09-22T19:41:36.557589Z",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "engagement_percent": "0.000",
  "id": "276398e8-9a5b-49e6-b6ce-f59d732521b3",
  "impression_count": 1,
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/image-poll/276398e8-9a5b-49e6-b6ce-f59d732521b3/",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/image-polls/276398e8-9a5b-49e6-b6ce-f59d732521b3/interactions/",
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "kind": "image-poll",
  "options": [
    {
      "description": "Seattle Seahawks",
      "id": "52406f98-f240-45c4-9927-f4ea53812c4f",
      "image_url": "https://cf-blast-storage.livelikecdn.com/assets/a7bba33c-7dd6-4402-bf06-63fb41979601.jpg",
      "translatable_fields": [
        "description"
      ],
      "vote_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-interactions/image-poll/276398e8-9a5b-49e6-b6ce-f59d732521b3/options/52406f98-f240-45c4-9927-f4ea53812c4f/votes/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCaFM0a3U4bGZmMjNJMWZ2QU5QejdnRzBabHVnV3FCYWpJVkxaUnVxdU81YWNyYXFZOUpDd0hDb0JyY2ppbkF0UXhXTVM3bVVyallxVjlnZ2hSVS1pWFl4ZG5EQT09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2MzIzNDAyNzB9.ih6WUDFs_fFXe_uwOGWvIBDEHS933jXUhIipB2KWjEI/"
    }
  ],
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "publish_delay": "P0DT00H00M00S",
  "published_at": "2021-09-22T19:41:36.889351Z",
  "question": "Who do you think will win the game?",
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/image-polls/276398e8-9a5b-49e6-b6ce-f59d732521b3/schedule/",
  "scheduled_at": "2021-09-22T19:41:36.796713Z",
  "status": "published",
  "subscribe_channel": "program.widget.276398e8-9a5b-49e6-b6ce-f59d732521b3",
  "timeout": "P0DT00H00M30S",
  "translatable_fields": [
    "question"
  ],
  "unique_impression_count": 1,
  "url": "https://cf-blast.livelikecdn.com/api/v1/image-polls/276398e8-9a5b-49e6-b6ce-f59d732521b3/",
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?image_poll_id=276398e8-9a5b-49e6-b6ce-f59d732521b3"
}