Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Get Text Prediction

get/{prediction_id}/

Response

200

idstring
pubnub_enabledboolean
urlstring
kindstring
program_idstring
client_idstring
created_atstring
{"stackTrail":"paths:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:published_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:scheduled_at","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:interactive_until","oasType":"schema","type":"unknown"}
follow_up_urlstring
questionstring
confirmation_messagestring
timeoutstring
subscribe_channelstring
{"stackTrail":"paths:/{prediction_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:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:rewards_url","oasType":"schema","type":"unknown"}
translationsobject
translatable_fieldsstring[]
{"stackTrail":"paths:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:custom_data","oasType":"schema","type":"unknown"}
widget_interactions_url_templatestring
{"stackTrail":"paths:/{prediction_id}/:get:responses:200:content:application/json:schema:properties:playback_time_ms","oasType":"schema","type":"unknown"}

Example response

{
  "id": "5f1a5c3f-a17c-4f97-b88f-59a3e72ef013",
  "pubnub_enabled": true,
  "url": "https://cf-blast.livelikecdn.com/api/v1/text-predictions/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/",
  "kind": "text-prediction",
  "program_id": "94762042-f447-42e8-aea8-07ad65edd910",
  "client_id": "8PqSNDgIVHnXuJuGte1HdvOjOqhCFE1ZCR3qhqaS",
  "created_at": "2023-12-12T11:33:40.807636Z",
  "follow_up_url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-follow-ups/",
  "follow_ups": [
    {
      "id": "a73cf2df-790e-46b4-90ea-e5e4fb2fe202",
      "pubnub_enabled": true,
      "url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-follow-ups/a73cf2df-790e-46b4-90ea-e5e4fb2fe202/",
      "program_id": "94762042-f447-42e8-aea8-07ad65edd910",
      "client_id": "8PqSNDgIVHnXuJuGte1HdvOjOqhCFE1ZCR3qhqaS",
      "text_prediction_id": "5f1a5c3f-a17c-4f97-b88f-59a3e72ef013",
      "text_prediction_url": "https://cf-blast.livelikecdn.com/api/v1/text-predictions/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/",
      "timeout": "P0DT00H00M30S",
      "created_at": "2023-12-12T11:33:40.860166Z",
      "subscribe_channel": "program.widget.94762042-f447-42e8-aea8-07ad65edd910",
      "kind": "text-prediction-follow-up",
      "options": [
        {
          "id": "48b9a173-a100-4751-9d30-cc33bef035e0",
          "url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-options/48b9a173-a100-4751-9d30-cc33bef035e0/",
          "description": "1",
          "vote_url": "https://blast-prod-us-east-1.livelikeblast.com/api/v1/widget-interactions/text-prediction/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/options/48b9a173-a100-4751-9d30-cc33bef035e0/votes/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCbGVGcnVOOU5VQUYtOWhiSWpkRFFSWEw0MnVIY0dvMEJqY0I5UWYtUm90Y0JtNHRfUGkwUndkVGlOWkRNZER0QXdudnpWN3U3T3lNbkZiTTAzVjI0SDJ6YW9EQT09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE3MDIzODY0MTR9.75N8g3TadfOKDIvIudC7utgH57dYUTFtyrd3v9IIfUc/",
          "translatable_fields": [
            "description"
          ]
        }
      ],
      "question": "test",
      "publish_delay": "P0DT00H00M00S",
      "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-follow-ups/a73cf2df-790e-46b4-90ea-e5e4fb2fe202/interactions/",
      "impression_url": "https://blast-prod-us-east-1.livelikeblast.com/api/v1/widget-impressions/text-prediction-follow-up/a73cf2df-790e-46b4-90ea-e5e4fb2fe202/",
      "status": "pending",
      "created_by": {
        "id": "fccbb60d-c8b0-49fd-958c-87dc8f059bf8"
      },
      "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-follow-ups/a73cf2df-790e-46b4-90ea-e5e4fb2fe202/schedule/",
      "claim_url": "https://blast-prod-us-east-1.livelikeblast.com/api/v1/widget-interaction-claims/text-prediction/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/claims/",
      "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_prediction_id=5f1a5c3f-a17c-4f97-b88f-59a3e72ef013"
    }
  ],
  "question": "test",
  "confirmation_message": "Alright! Stay tuned to see the result.",
  "timeout": "P0DT00H00M30S",
  "options": [
    {
      "id": "48b9a173-a100-4751-9d30-cc33bef035e0",
      "url": "https://cf-blast.livelikecdn.com/api/v1/text-prediction-options/48b9a173-a100-4751-9d30-cc33bef035e0/",
      "description": "1",
      "vote_url": "https://blast-prod-us-east-1.livelikeblast.com/api/v1/widget-interactions/text-prediction/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/options/48b9a173-a100-4751-9d30-cc33bef035e0/votes/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbmNyeXB0ZWQiOiJnQUFBQUFCbGVGcnVQNE9rdldoakpLUmhPT0ZCMExjRnRNTDU1X05pSWhFVFNCYkFBcDZRLV9NcVJRMnp3N3dEWWp4VEw4NDFYOENnMGtydXZrVzdVVmJUVUpXSDlzQXdRdz09IiwiaXNzIjoiYmxhc3QiLCJpYXQiOjE3MDIzODY0MTR9.3AVcT9J-CYT_idCOiRPpQdsrnqxSwY_0K8nHv2iQHAA/",
      "translatable_fields": [
        "description"
      ]
    }
  ],
  "subscribe_channel": "program.widget.94762042-f447-42e8-aea8-07ad65edd910",
  "publish_delay": "P0DT00H00M00S",
  "interaction_url": "https://cf-blast.livelikecdn.com/api/v1/text-predictions/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/interactions/",
  "impression_url": "https://blast-prod-us-east-1.livelikeblast.com/api/v1/widget-impressions/text-prediction/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/",
  "engagement_percent": "0.000",
  "status": "pending",
  "created_by": {
    "id": "fccbb60d-c8b0-49fd-958c-87dc8f059bf8"
  },
  "schedule_url": "https://cf-blast.livelikecdn.com/api/v1/text-predictions/5f1a5c3f-a17c-4f97-b88f-59a3e72ef013/schedule/",
  "translatable_fields": [
    "question"
  ],
  "widget_interactions_url_template": "https://cf-blast.livelikecdn.com/api/v1/profiles/{profile_id}/widget-interactions/?text_prediction_id=5f1a5c3f-a17c-4f97-b88f-59a3e72ef013"
}