View ultra low latency usage with the Wowza Streaming Cloud REST API

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: Ultra low latency streaming is available through Wowza Streaming Cloud with Ultra Low Latency. For more information see About ultra low latency streaming with Wowza Streaming Cloud.

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

https://api.cloud.wowza.com/api/[version]/usage/network/stream_targets

Example request and response

Notes:

curl -X GET \
-H "wsc-api-key: ${WSC_API_KEY}" \
-H "wsc-access-key: ${WSC_ACCESS_KEY}" \
"${WSC_HOST}/api/${WSC_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 usage is listed by the zone where the servers are located. See Ultra low latency zones for more information about zones. HLS streams have one zone, global.

Note: In v1.3 and earlier of the Wowza Streaming Cloud REST API, bytes_billed now returns a value of 0. Due to timing differences between usage and billing systems, the previous bytes_billed value didn't consistently reflect the number of bytes billed for in a billing cycle.

The response for ultra low latency usage looks something like this:

{
    "total": {
        "bytes_used": 50004000,
        "protocols": {
            "ull": {
                "zones": {
                    "zone_1": {
                        "bytes_used": 30002000
                    }
                }
            },
            "hls": {
                "zones": {
                    "global": {
                        "bytes_used": 20002000
                    }
                }
            }
        },
        "bytes_billed": 0
    },
    "stream_targets": [
        {
            "id": "9xlpntfz",
            "name": "My ultra low latency pull target with HLS backup",
            "deleted": false,
            "bytes_used": 50004000,
            "protocols": {
                "ull": {
                    "zones": {
                        "zone_1": {
                            "bytes_used": 30002000,
                            "bytes_billed": 0
                        }
                    }
                },
                "hls": {
                    "zones": {
                        "global": {
                            "bytes_used": 20002000,
                            "bytes_billed": 0
                        }
                    }
                }
            }
        }
    ]
}