List All Live Sessions

Returns a list of existing live sessions that belong to the requested live entity, in sorted order where the most recently created live session shows up first.

/v1/live_entities/:id/live_sessions

GET https://api.uiza.sh/v1/live_entities/:id/live_sessions

Path Parameters

Name	Type	Description
id	string	The identifier of the live entity whose live sessions are to be retrieved.

Query Parameters

Name	Type	Description
dvr	string	Filtering the sessions with the DVR option. Set as true to list all sessions has lived with DVR and set as false to list all the rest.
page_size	string	The maximum number of objects to be returned, between 1 and 20.
page_token	string	The pagination cursor of the result page to be retrieved.

200 Cake successfully retrieved.

{
    "data": [
        {
            "id": "86b55280-de82-497a-80b5-466b5d7d3d1d",
            "live_entity_id": "df0c96c0-c9ed-4d66-ba3a-cc09e36b3828",
            "video_entity_id": "",
            "ingest_key": "live_Yez8pTBcPh",
            "duration": 109.517,
            "dvr": false,
            "preset": {
                "id": "8ab03df6-1dde-4625-a3eb-ef5cf62e4e6e",
                "name": "Uiza LIVE 480p",
                "description": "Made by developer",
                "is_default": false,
                "profiles": [
                    {
                        "id": "735299b7-5988-11ea-883b-028fc5698662",
                        "name": "480p H264 30fps Normal Latency",
                        "segment_duration": 4,
                        "orientation": "landscape",
                        "video_profile": {
                            "video_resolution": "480",
                            "video_codec": "H264",
                            "video_bitrate": "1000K",
                            "video_frame_rate": "30"
                        },
                        "audio_profile": {
                            "audio_channel": "2",
                            "audio_codec": "AAC",
                            "audio_bitrate": "128K",
                            "audio_frame_rate": "1"
                        }
                    }
                ],
                "created_at": "2020-03-16T09:06:21Z",
                "updated_at": "2020-03-17T06:47:20Z"
            },
            "created_at": "2020-03-18T03:09:12Z",
            "updated_at": "2020-03-18T03:11:01Z"
        },
        {
            "id": "26bc07f6-c581-4c77-acbe-4ed7564d2e39",
            "live_entity_id": "df0c96c0-c9ed-4d66-ba3a-cc09e36b3828",
            "video_entity_id": "f42b4ac3-869e-4010-8e21-042e40be7655",
            "ingest_key": "live_Yez8pTBcPh",
            "duration": 324.703,
            "dvr": true,
            "preset": {
                "id": "8ab03df6-1dde-4625-a3eb-ef5cf62e4e6e",
                "name": "Uiza LIVE 480p",
                "description": "Made by developer",
                "is_default": false,
                "profiles": [
                    {
                        "id": "735299b7-5988-11ea-883b-028fc5698662",
                        "name": "480p H264 30fps Normal Latency",
                        "segment_duration": 4,
                        "orientation": "landscape",
                        "video_profile": {
                            "video_resolution": "480",
                            "video_codec": "H264",
                            "video_bitrate": "1000K",
                            "video_frame_rate": "30"
                        },
                        "audio_profile": {
                            "audio_channel": "2",
                            "audio_codec": "AAC",
                            "audio_bitrate": "128K",
                            "audio_frame_rate": "1"
                        }
                    }
                ],
                "created_at": "2020-03-16T09:06:21Z",
                "updated_at": "2020-03-17T06:47:20Z"
            },
            "created_at": "2020-03-18T03:00:32Z",
            "updated_at": "2020-03-18T03:05:56Z"
        }
    ],
    "next_page_token": "eyJjcmVhdGVkX2F0IjoxNTc2MDA4NjkxMDAwLCJpZCI6IjAwNzVmZjcyLWE0ODYtNDg0Ni05Y2NjLWY1ZWU4YTA0MmQ0NSJ9",
    "prev_page_token": ""
}

400

{
 "message": "Your request is missing id parameter. Please, verify and resubmit.",
 "error_type": "invalid_request_error"
}

401

{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}

404

{
 "message": "The live entity you requested does not exist.",
 "error_type": "invalid_request_error"
}

500

{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}

Sample Request

curl -X GET https://api.uiza.sh/v1/live_entities/22013d8a-d5fa-48f0-9a63-1f471ca9e81d/sessions 
    -H 'Accept: */*' 
    -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64' 
    -H 'Cache-Control: no-cache' 
    -H 'Connection: keep-alive'