Hierarchy

Index

Properties

Properties

Optional choices

choices: IChoiceItem[]

Widget choice array

claim_url

claim_url: string

Optional content

content: string

HTML string to be rendered

created_at

created_at: string

When widget was created

created_by

created_by: { id: string; image_url: string | null; name: string | null }

User that created the widget

Type declaration

  • id: string
  • image_url: string | null
  • name: string | null

Optional custom_data

custom_data: string

Widget custom data

engagement_count

engagement_count: number

engagement_percent

engagement_percent: string

Optional follow_ups

follow_ups: IWidgetPayload[] | any

Follow up widget payload for prediction widgets

id

id: string

Optional image_number_prediction_id

image_number_prediction_id: string

Follow Up Widget Image Number Prediction Id

Optional image_prediction_id

image_prediction_id: string

Follow Up Widget Image Prediction Id

impression_count

impression_count: number

impression_url

impression_url: string

interaction_url

interaction_url: string

kind

kind: WidgetKind

Optional options

options: IOptionItem[]

Widget options array

program_date_time

program_date_time: string | null

Sync time

program_id

program_id: string

Id of program the widget was created in

publish_delay

publish_delay: string

Delay for when widget is published

Optional published_at

published_at: string | null

Time widget was published

Optional question

question: string

Widget question

reactions

reactions: IWidgetReaction[] | null

Widget reactions

Optional reply_url

reply_url: string

rewards_url

rewards_url: string | null

schedule_url

schedule_url: string

Optional scheduled_at

scheduled_at: string | null

Time widget was scheduled

sponsors

sponsors: ISponsorPayload[]

status

status: "pending" | "published" | "in-flight"

subscribe_channel

subscribe_channel: string

Optional text_number_prediction_id

text_number_prediction_id: string

Follow Up Widget Text Number Prediction Id

Optional text_prediction_id

text_prediction_id: string

Follow Up Widget Text Prediction Id

timeout

timeout: string

Widget duration

Optional timetoken

timetoken: string

unique_impression_count

unique_impression_count: number

url

url: string