LiveStreams

List livestreams of a channel

Lists primary, non-showroom livestreams for a channel. Use the returned id values as live_stream_id inputs to the livestream reporting stats endpoint.

get/api/v1/live_streams

Request

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

Query parameters

channel_idstring required

channel ID

statusesstring

Comma-separated status filter, e.g. "active,replay"

archivedboolean

Archived filter: omitted or false returns only non-archived livestreams; true returns only archived ones

afterstring

Opaque cursor for the next page (from pagination.cursor or links.next); ascending order.

beforestring

Opaque cursor for the previous page; descending order.

page_sizeinteger

Page size (default 10, max 100)

Response

Paginated livestreams

Changes

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