Interface PlaylistGetGroupRunsSuccess

Successful response from playlist.getGroupRuns.

interface PlaylistGetGroupRunsSuccess {
    contentVersion: string;
    playlist: number;
    playlistGuid: string;
    runs: PlaylistGroupRun[];
    success: true;
    total: number;
}

Properties

contentVersion: string

The runs describe the rows as they were at this version.

playlist: number

The playlist grouped.

playlistGuid: string

Unique identifier of the playlist, formatted as {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}. Pass as playlistGuid to reliably target this playlist.

The runs in playlist order, the first starting at row 0; empty for an empty playlist.

success: true

Always true here; a failed call resolves with ApiFailure instead.

total: number

Rows in the playlist; the runs' count values add up to it.