v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get a Text Ask Widget

get/text-asks/{id}/

Path parameters

idstring required

Text Ask ID

Response

200

idstring
urlstring
kindstring
program_idstring
client_idstring
created_atstring
published_atstring
scheduled_atstring
titlestring
promptstring
confirmation_messagestring
timeoutstring
subscribe_channelstring
{"stackTrail":"paths:/text-asks/{id}/:get:responses:200:content:application/json:schema:properties:program_date_time","oasType":"schema","type":"unknown"}
publish_delaystring
interaction_urlstring
impression_urlstring
impression_countinteger
interactive_untilstring
unique_impression_countinteger
engagement_countinteger
engagement_percentstring
statusstring
schedule_urlstring
{"stackTrail":"paths:/text-asks/{id}/:get:responses:200:content:application/json:schema:properties:rewards_url","oasType":"schema","type":"unknown"}
translationsobject
translatable_fieldsstring[]
{"stackTrail":"paths:/text-asks/{id}/:get:responses:200:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}
widget_interactions_url_templatestring
reply_urlstring
reply_countinteger

Example response

{
  "id": "a91d99db-436d-414d-abd9-292683ba182e",
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/",
  "kind": "text-ask",
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "created_at": "2021-09-22T19:46:29.217285Z",
  "published_at": "2021-09-22T19:46:29.594342Z",
  "scheduled_at": "2021-09-22T19:46:29.430763Z",
  "title": "AMA with Russell Wilson!",
  "prompt": "Ask Russell Wilson your questions and see if yours is selected!",
  "confirmation_message": "Thanks for your submission!  Tune in at 8 PM to see if your question was selected!",
  "timeout": "P0DT00H00M30S",
  "subscribe_channel": "program.widget.a91d99db-436d-414d-abd9-292683ba182e",
  "publish_delay": "P0DT00H00M00S",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/interactions/",
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/text-ask/a91d99db-436d-414d-abd9-292683ba182e/",
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "engagement_percent": "0.000",
  "status": "published",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/schedule/",
  "translatable_fields": [
    "title"
  ],
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_ask_id=a91d99db-436d-414d-abd9-292683ba182e",
  "reply_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/text-asks/a91d99db-436d-414d-abd9-292683ba182e/replies/"
}