v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get a Text Quiz

get/text-quizzes/{id}/

Path parameters

idstring required

Quiz ID

Response

200

idstring

urlstring

program_idstring

client_idstring

created_atstring

kindstring

published_atstring

scheduled_atstring

questionstring

timeoutstring

subscribe_channelstring

{"stackTrail":"paths:/text-quizzes/{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-quizzes/{id}/:get:responses:200:content:application/json:schema:properties:rewards_url","oasType":"schema","type":"unknown"}

translationsobject

translatable_fieldsstring[]

{"stackTrail":"paths:/text-quizzes/{id}/:get:responses:200:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}

widget_interactions_url_templatestring

{"stackTrail":"paths:/text-quizzes/{id}/:get:responses:200:content:application/json:schema:properties:playback_time_ms","oasType":"schema","type":"unknown"}

Example response

{
  "id": "cfa2139a-2430-44e4-9e2f-a17a46ab6466",
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/",
  "program_id": "075a1d11-1489-4dd0-b7c4-a7642f5f517f",
  "client_id": "UJQCf1jWIhKmQpOYdhe6H56Uc4Xp50b1zdVaOowO",
  "created_at": "2021-09-22T19:42:13.569848Z",
  "kind": "text-quiz",
  "published_at": "2021-09-22T19:42:13.813239Z",
  "scheduled_at": "2021-09-22T19:42:13.721870Z",
  "question": "Which team has won a Super Bowl more recently?",
  "timeout": "P0DT00H00M30S",
  "choices": [
    {
      "id": "cdf0ad02-b51d-4646-b0ca-2f0361f2c6ce",
      "description": "Seattle Seahawks",
      "answer_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-interactions/text-quiz/cfa2139a-2430-44e4-9e2f-a17a46ab6466/choices/cdf0ad02-b51d-4646-b0ca-2f0361f2c6ce/answers/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCaFRHR3BKM3FZdXdGVk5zWTdvQVVORGh6SnZ2dHkzYjAtR2lIb3dzWVBabTZlN01aZWg0Vl9ZRy1Bd0twU2wyN0JiUllKZy1NY0xjN1JPenVMbVN4YVhlSHlBdz09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE2MzIzOTU2ODl9.GLLYYuFQFB6ErNKQTSoYJMK7rE-A5g8HjYIm5-WiYxY/",
      "translatable_fields": [
        "description"
      ]
    }
  ],
  "subscribe_channel": "program.widget.cfa2139a-2430-44e4-9e2f-a17a46ab6466",
  "publish_delay": "P0DT00H00M00S",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/interactions/",
  "impression_url": "https://blastrt-prod-us-east-1.livelikecdn.com/api/v1/widget-impressions/text-quiz/cfa2139a-2430-44e4-9e2f-a17a46ab6466/",
  "impression_count": 1,
  "interactive_until": "2022-01-18T18:53:56.510Z",
  "unique_impression_count": 1,
  "engagement_percent": "0.000",
  "status": "published",
  "created_by": {
    "id": "1bf5b2ff-d82b-4400-b4eb-38a8d7bf538c"
  },
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-quizzes/cfa2139a-2430-44e4-9e2f-a17a46ab6466/schedule/",
  "translatable_fields": [
    "question"
  ],
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_quiz_id=cfa2139a-2430-44e4-9e2f-a17a46ab6466"
}