LiveStreams

Get a livestream

get/api/v1/live_streams/{id}

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/live_streams/{id}
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: livestreams:read)

Path parameters

idstring required

livestream ID

Response

The livestream, including interactions

event_namestring nullable
interactionsobject[]

Polls, quizzes and questions; only returned on show

replay_messaging_enabledboolean
chat_enabledboolean
transcription_enabledboolean
auto_responsestring nullable
ended_atstring date-time nullable
hearts_count_enabledboolean
stream_urlstring

Only returned on create/update when stream_source is "external"

scheduled_atstring date-time nullable
fomo_product_viewing_enabledboolean
has_access_codeboolean
video_idstring

backing video ID

replay_viewers_count_enabledboolean
replay_enabledboolean
viewers_count_enabledboolean
chat_in_replay_enabledboolean
auto_start_enabledboolean
started_atstring date-time nullable
simulcast_providerstring nullable

Simulcast backend provider; only returned on show

replay_interactions_enabledboolean
base_video_idstring nullable

BaseVideo ID

idstring

livestream ID

providerstring

Only returned on create

viewers_count_modestring nullable
stream_keystring

Only returned on create/update when stream_source is "external"

trailer_messaging_enabledboolean
stream_source'fw' | 'external' | 'prerecorded'
thumbnail_urlstring nullable
trailer_announcement_enabledboolean
event_descriptionstring nullable
chat_moderation_enabledboolean
announcementstring nullable
channel_idstring

channel ID

status'idle' | 'active' | 'paused' | 'replay' | 'completed' | 'expired'

Changes

No recorded changes to this operation across all 1 revision of this API.