Skip to main content

Query Ingest Bandwidth

Query peak ingest bandwidth usage per 5-minute interval.

Request

Request-Line

Get /lls/v1.0/analytics/ingest/queryIngestBandwidth

Request Parameters

Query Parameters

ParameterTypeRequiredDescription
domainStringMandatoryIngest domain name
appStringOptionalApplication name
streamStringOptionalStream name
regionStringOptionalcountry code of the ingest node. refer to ISO 3166-1 Alpha-2.
startedTimestampOptionalTimestamp of started time in UTC timezone.
endedTimestampOptionalTimestamp of ended time in UTC timezone.

Response

Response Body

ParameterTypeRequiredDescription
domainStringMandatoryIngest domain name
appStringOptionalApplication name
streamStringOptionalStream name
startedTimestampOptionalTimestamp of started time in UTC timezone.
endedTimestampOptionalTimestamp of ended time in UTC timezone.
dataArrayMandatoryArray of Data Object

Object: Data

ParameterTypeRequiredDescription
timestampTimestampMandatoryExampling timestamp in UTC timezone.
ingestBandwidthFloatMandatorymaximum number of the total bandwidth of ingest streams

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400LLS.Analytics.InvalidTimestampTimestamp is empty or invalid.

Examples

Query real-time bandwidth of ingest streams

Request

Get /lls/v1.0/analytics/ingest/queryIngestBandwidth?domain=live.example.com&app=demoapp HTTP/1.1

Successful Response Body

{
"domain": "live.example.com",
"app": "demoapp",
"data": [
{
"timestamp": "20250518T173000Z",
"ingestBandwidth": 128238.39
}
]
}

Query bandwidth of ingest streams in specified time range

Request

Get /lls/v1.0/analytics/ingest/queryIngestBandwidth?domain=live.example.com&app=demoapp&started=20250518T173000Z&ended=20250518T180000Z HTTP/1.1 

Successful Response Body

{
"domain": "live.example.com",
"app": "demoapp",
"started": "20250518T173000Z",
"ended": "20250518T180000Z",
"data": [
{
"timestamp": "20250518T173000Z",
"ingestBandwidth": 128332.38
},
{
"timestamp": "20250518T173500Z",
"ingestBandwidth": 135475.45
},
{
"timestamp": "20250518T174000Z",
"ingestBandwidth": 182395.36
},
{
"timestamp": "20250518T174500Z",
"ingestBandwidth": 203443.64
},
{
"timestamp": "20250518T175000Z",
"ingestBandwidth": 256886.96
},
{
"timestamp": "20250518T175500Z",
"ingestBandwidth": 287376.95
},
{
"timestamp": "20250518T18000Z",
"ingestBandwidth": 327626.63
},
]
}

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