Video API, gRPC: EpisodeService.List

Field

Description

stream_id

string

ID of the stream containing the episodes to list.

The maximum string length in characters is 50.

Includes only one of the fields stream_id, line_id.

Specifies the parent resource to list episodes from (exactly one must be chosen).

line_id

string

ID of the stream line containing the episodes to list.

The maximum string length in characters is 50.

Includes only one of the fields stream_id, line_id.

Specifies the parent resource to list episodes from (exactly one must be chosen).

page_size

int64

The maximum number of episodes to return per page.

The maximum value is 100.

page_token

string

Page token for retrieving the next page of results.
This token is obtained from the next_page_token field in the previous ListEpisodesResponse.

The maximum string length in characters is 15000.

order_by

string

Specifies the ordering of results.
Format is "<field> <order>" (e.g., "createdAt desc").
Default: "id asc".
Supported fields: ["id", "createdAt", "updatedAt"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 50.

filter

string

Filter expression to narrow down the list of returned episodes.
Expressions consist of terms connected by logical operators.
Values containing spaces or quotes must be enclosed in quotes (' or ")
with inner quotes being backslash-escaped.

Supported logical operators: ["AND", "OR"].
Supported comparison operators: ["=", "!=", ":"] where ":" enables substring matching.
Parentheses can be used to group logical expressions.

Example: title:'highlight' AND id='episode-1'

Filterable fields: ["id", "title"].
Both snake_case and camelCase field names are supported.

The maximum string length in characters is 1000.

Field

Description

episodes[]

Episode

List of episodes matching the request criteria.
May be empty if no episodes match the criteria or if the parent resource has no episodes.

next_page_token

string

Token for retrieving the next page of results.
Empty if there are no more results available.

Field

Description

id

string

Unique identifier of the episode.

stream_id

string

Identifier of the stream this episode is linked to.
Optional, empty if the episode is linked to a line.

line_id

string

Identifier of the line this episode is linked to.
Optional, empty if the episode is linked to a stream.

title

string

Title of the episode displayed in interfaces and players.

description

string

Detailed description of the episode content and context.

thumbnail_id

string

Identifier of the thumbnail image used to represent the episode visually.

start_time

google.protobuf.Timestamp

Timestamp marking the beginning of the episode content.

finish_time

google.protobuf.Timestamp

Timestamp marking the end of the episode content.

dvr_seconds

int64

Controls the Digital Video Recording (DVR) functionality for the episode.
Determines how many seconds of the stream are available for time-shifted viewing.

Possible values:

• 0: Infinite DVR size, the full length of the stream is available for viewing.
• >0: Size of DVR window in seconds, the minimum value is 30s.

visibility_status

enum VisibilityStatus

Current visibility status controlling whether the episode is publicly available.

• VISIBILITY_STATUS_UNSPECIFIED: The visibility status is not specified.
• PUBLISHED: The episode is publicly available, subject to its access permission settings.
• UNPUBLISHED: The episode is available only to administrators.

style_preset_id

string

Identifier of the style preset used in the player during episode playback.

public_access

EpisodePublicAccessRights

Allows unrestricted public access to the episode via direct link.
No additional authorization or access control is applied.

Includes only one of the fields public_access, sign_url_access.

Specifies the episode access permission settings.

sign_url_access

EpisodeSignURLAccessRights

Restricts episode access using URL signatures for secure time-limited access.

Includes only one of the fields public_access, sign_url_access.

Specifies the episode access permission settings.

created_at

google.protobuf.Timestamp

Timestamp when the episode was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the episode or its metadata.

Field

Description

Empty

Field

Description

Empty