Query Metadata of a stream
Queries the medata, including bit rate and frame rate, of a stream between the specified time range. The maximum query time span is one hour. You can query data over the past seven days.
Request
Request-Line
GET /lls/v1.0/analytics/stream/queryStreamMetadata
Request Parameters
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
domain | String | Mandatory | Ingest domain name |
app | String | Optional | Application name |
stream | String | Optional | Stream name |
started | Timestamp | Mandatory | Timestamp of started time in UTC timezone. |
ended | Timestamp | Mandatory | Timestamp of ended time in UTC timezone. |
Response
Response Body
Parameter | Type | Required | Description |
---|---|---|---|
domain | String | Mandatory | Ingest domain name |
app | String | Optional | Application name |
stream | String | Optional | Stream name |
data | Array | Mandatory | Array of Bit Rates Object |
Object: Bit Rates
Parameter | Type | Required | Description |
---|---|---|---|
timestamp | Timestamp | Mandatory | Exampling timestamp in UTC timezone. |
bitRate | Integer | Mandatory | Bit rate. Unit is kbps. |
frameRate | Integer | Mandatory | Frame rate. |
Status Codes, Error Codes and Error Messages
Status Code | Error Code | Error Message |
---|---|---|
400 | LLS.Analytics.InvalidTimestamp | Timestamp is empty or invalid. |
Examples
Query Bit Rate of a stream
Request
GET /lls/v1.0/analytics/transcoding/queryStreamMetadata?domain=ingest.example.com&app=demoapp&stream=demostream01&started=20250518T173000Z&ended=20250518T173030Z HTTP/1.1
Successful Response Body
{
"domain": "ingest.example.com",
"app": "demoapp",
"stream": "demostream01",
"data": [
{
"timestamp": "20250518T173000Z",
"bitRate": 3030,
"frameRate": 28
},
{
"timestamp": "20250518T173005Z",
"bitRate": 2850,
"frameRate": 31
},
{
"timestamp": "20250518T173010Z",
"bitRate": 2905,
"frameRate": 31
},
{
"timestamp": "20250518T173015Z",
"bitRate": 2950,
"frameRate": 30
},
{
"timestamp": "20250518T173020Z",
"bitRate": 2880,
"frameRate": 29
},
{
"timestamp": "20250518T173025Z",
"bitRate": 2990,
"frameRate": 31
},
{
"timestamp": "20250518T173030Z",
"bitRate": 3025,
"frameRate": 30
}
]
}
Best Practices
Rate Limiting
Rate Limits
Rate limiting is posed upon the API, please kindly check your API calls to ensure complying with the rate limit below:
- 100 requests per minute
- 1000 requests per hour