List all live streams
GET {{baseUrl}}/live-streams?streamKey=<string>&name=<string>&sortBy=<string>&sortOrder=asc¤tPage=1&pageSize=25
Get the list of livestreams on the workspace.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
streamKey | string | The unique stream key that allows you to stream videos. | |
name | string | You can filter live streams by their name or a part of their name. | |
sortBy | string | Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format. | |
sortOrder | string | Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending. | |
currentPage | number | Choose the number of search results to return per page. Minimum value: 1 | |
pageSize | number | Results per page. Allowed values 1-100, default is 25. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"liveStreamId":"\u003cstring\u003e","restreams":[{"name":"\u003cstring\u003e","serverUrl":"\u003cstring\u003e","streamKey":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","serverUrl":"\u003cstring\u003e","streamKey":"\u003cstring\u003e"}],"name":"\u003cstring\u003e","streamKey":"\u003cstring\u003e","public":"\u003cboolean\u003e","assets":{"hls":"\u003curi\u003e","iframe":"\u003cstring\u003e","player":"\u003curi\u003e","thumbnail":"\u003curi\u003e"},"playerId":"\u003cstring\u003e","broadcasting":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"},{"liveStreamId":"\u003cstring\u003e","restreams":[{"name":"\u003cstring\u003e","serverUrl":"\u003cstring\u003e","streamKey":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","serverUrl":"\u003cstring\u003e","streamKey":"\u003cstring\u003e"}],"name":"\u003cstring\u003e","streamKey":"\u003cstring\u003e","public":"\u003cboolean\u003e","assets":{"hls":"\u003curi\u003e","iframe":"\u003cstring\u003e","player":"\u003curi\u003e","thumbnail":"\u003curi\u003e"},"playerId":"\u003cstring\u003e","broadcasting":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e"}],"pagination":{"links":[{"rel":"\u003cstring\u003e","uri":"\u003curi\u003e"},{"rel":"\u003cstring\u003e","uri":"\u003curi\u003e"}],"itemsTotal":"\u003cinteger\u003e","pagesTotal":"\u003cinteger\u003e","pageSize":"\u003cinteger\u003e","currentPage":"\u003cinteger\u003e","currentPageItems":"\u003cinteger\u003e"}}