Learn how to use the REST API to get usage data for an ultra low latency stream target in the Wowza Streaming Cloud™ service. Usage data includes bandwidth for each zone and protocol used by the stream target.
Note: The Wowza ultra low latency REST API is in private preview release. For information see Ultra Low Latency with Wowza.
Contents
Usage parameters
View network usage for an ultra low latency stream target
Usage parameters
| Parameter | Data Type | Description |
| from | datetime | The start of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The default from is the last billing date. |
| to | datetime | The end of the range of time you want to view. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC. The default to is the end of the current day. |
View network usage for an ultra low latency stream target
Network usage, also called bandwidth, is the amount of data that went through the Wowza Streaming Cloud ultra low latency stream target. To view usage for stream targets, call the resource
Example request and response
Notes:
- For [key], substitute your API key or your access key as appropriate. For more information, see Locating and using API and access keys.
- For [version], substitute the version number of the API that you're using. For the current version, use v1.1.
curl -G -H 'wsc-api-key: [key]' -H 'wsc-access-key: [key]' -H 'Content-Type: application/json' https://api.cloud.wowza.com/api/[version]/usage/network/stream_targets/
The query returns details on usage for all stream targets during the specified timeframe. Usage for ultra low latency targets is listed by protocol (ultra low latency, or ull, and Apple HLS, or hls). Ultra low latency usage is listed by the zone where the servers are located. Apple HLS streams have one zone, global.
The response for ultra low latency usage looks something like this:
{
"total": {
"bytes_used": 50004000,
"bytes_billed": 50004000,
"protocols": {
"ull": {
"zones": {
"azure-westus": {
"bytes_used": 30002000,
"bytes_billed": 30002000
}
}
},
"hls": {
"zones": {
"global": {
"bytes_used": 20002000,
"bytes_billed": 20002000
}
}
}
}
},
"stream_targets": [
{
"id": "9xlpntfz",
"name": "My ultra low latency pull target with HLS backup",
"deleted": false,
"bytes_used": 50004000,
"bytes_billed": 50004000,
"protocols": {
"ull": {
"zones": {
"azure-westus": {
"bytes_used": 30002000,
"bytes_billed": 30002000
}
}
},
"hls": {
"zones": {
"global": {
"bytes_used": 20002000,
"bytes_billed": 20002000
}
}
}
}
}
]
}
Note: Network usage for ultra low latency streams is available almost immediately. Bandwidth for Apple HLS streams, however, is subject to a delay of up to three hours. Billing information updates every 12 hours. As a result, bytes_used and bytes_billed may differ.
If you're having problems or want to discuss this article, post in our forum.
