v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get an Image Quiz

get/image-quizzes/{id}/

Path parameters

idstring required

Response

200

idstring

pubnub_enabledboolean

urlstring

program_idstring

client_idstring

created_atstring

kindstring

published_atstring

scheduled_atstring

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

questionstring

timeoutstring

subscribe_channelstring

{"stackTrail":"paths:/image-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

unique_impression_countinteger

engagement_countinteger

engagement_percentstring

statusstring

schedule_urlstring

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

translationsobject

translatable_fieldsstring[]

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

widget_interactions_url_templatestring

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

Example response

{
  "id": "de255e6e-264f-421f-a738-a7a62111d0f6",
  "pubnub_enabled": true,
  "url": "https://cf-blast.livelikecdn.com/api/v1/image-quizzes/de255e6e-264f-421f-a738-a7a62111d0f6/",
  "program_id": "2dee9d71-8f77-4485-82f4-622e74f82f10",
  "client_id": "pnODbVXg0UI80s0l2aH5Y7FOuGbftoAdSNqpdvo6",
  "created_at": "2023-11-22T08:16:18.608435Z",
  "kind": "image-quiz",
  "published_at": "2023-11-22T08:16:50.206033Z",
  "scheduled_at": "2023-11-22T08:16:18.999587Z",
  "question": "Image Quiz",
  "timeout": "P0DT00H00M30S",
  "choices": [
    {
      "id": "00bd9184-88d4-4197-a27d-c1ed3530b0f6",
      "description": "Choice 1",
      "image_url": "https://cf-blast-storage-qa.livelikecdn.com/assets/6f8ff3e0-aac8-4d9e-a995-be3b1ab8dd16.png",
      "answer_url": "https://blastrt-qa-us-east-1.livelikecdn.com/api/v1/widget-interactions/image-quiz/de255e6e-264f-421f-a738-a7a62111d0f6/choices/00bd9184-88d4-4197-a27d-c1ed3530b0f6/answers/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCbFhia0hIWS05aG1vRnljY3pSSDJLUFJlQ3JBRVpiRmRpYTl0VGRIcHVCTWl4alpBYkQ4UkJPeUNPVldpSEg5NUtMTlA5Wk5Gd2dPbGZqYnpBSlBaeWZvbXpkZz09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE3MDA2NDEwMzF9.7xKYbBZWl1HSQhP9pyReVKzr4I6jlc7HshgJehtw5HE/",
      "translatable_fields": [
        "description"
      ]
    }
  ],
  "subscribe_channel": "program.widget.de255e6e-264f-421f-a738-a7a62111d0f6",
  "publish_delay": "P0DT00H00M00S",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/image-quizzes/de255e6e-264f-421f-a738-a7a62111d0f6/interactions/",
  "impression_url": "https://blastrt-qa-us-east-1.livelikecdn.com/api/v1/widget-impressions/image-quiz/de255e6e-264f-421f-a738-a7a62111d0f6/",
  "engagement_percent": "0.000",
  "status": "published",
  "created_by": {
    "id": "e064f786-845e-4a3b-8fba-8f44ce5ab387"
  },
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/image-quizzes/de255e6e-264f-421f-a738-a7a62111d0f6/schedule/",
  "translatable_fields": [
    "question"
  ],
  "earnable_rewards": [
    {
      "reward_item_id": "1523fa9d-7d2f-4e4f-a615-f831fa965322",
      "reward_item_name": "actionReward",
      "reward_action_key": "quiz-answered",
      "reward_item_amount": 10
    }
  ],
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?image_quiz_id=de255e6e-264f-421f-a738-a7a62111d0f6"
}