Real Time Streams

Operations related to real time streams analytics.

Fetch usage for all real time streams

(Available from version 1.9) This operation returns detailed CDN usage data for all real time streams in the account. Defaults: from = last billing date, to = end of current day.

Request
query Parameters
from
string <date-time>

The start of the range of time you want to view. Specify YYYY-MM-DD HH:00:00 where HH is a 24-hour clock in UTC. The range doesn't include minutes and seconds and rounds minutes up to the hour. The maximum difference between from and to is 90 days. If you set the from query parameter without setting the to query parameter, the data returned will reflect 90 days starting at the from date, or data up to to the current day, whichever is shorter. T

You can also specify last_bill_date.

Default: last billing date

to
string <date-time>

The end of the range of time you want to view. Specify YYYY-MM-DD HH:00:00 where HH is a 24-hour clock in UTC. The range doesn't include minutes and seconds and rounds minutes up to the hour. The maximum difference between from and to is 90 days. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 90 days or from your last invoice date, whichever is shorter.

You can also specify last_bill_date.

Default: end of the current day

next_page_key
string

(Available from version 1.5) Returns a paginated view of results from the HTTP request. Specify a page key ID to indicate which page of the results should be displayed.

per_page
integer

For use with the next_page_key parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses
200

Success

Response Schema: application/json
object (Array of real time streams)

An array of real time streams and the details of their CDN usage.

object

Page information for the results generated by the query.

object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/real_time_streams
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/usage/real_time_streams"
Response samples
application/json
{
  • "real_time_streams": [
    ],
  • "pagination": {
    },
  • "limits": {
    }
}

Fetch usage for a single real time stream

(Available from version 1.9) This operation returns CDN usage details for a specific stream target. Defaults: from = last billing date, to = end of current day.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

query Parameters
from
string <date-time>

The start of the range of time you want to view. Specify YYYY-MM-DD HH:00:00 where HH is a 24-hour clock in UTC. The range doesn't include minutes and seconds and rounds minutes up to the hour. The maximum difference between from and to is 90 days. If you set the from query parameter without setting the to query parameter, the data returned will reflect 90 days starting at the from date, or data up to to the current day, whichever is shorter.

You can also specify last_bill_date.

Default: last billing date

to
string <date-time>

The end of the range of time you want to view. Specify YYYY-MM-DD HH:00:00 where HH is a 24-hour clock in UTC. The range doesn't include minutes and seconds and rounds minutes up to the hour. The maximum difference between from and to is 90 days. If you set the to query parameter without setting the from query parameter, the data returned will be from the past 90 days or from your last invoice date, whichever is shorter.

You can also specify last_bill_date.

Default: end of the current day

Responses
200

Success

Response Schema: application/json
object (real_time_stream)
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/real_time_streams/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/beta/usage/real_time_streams/2adffc17"
Response samples
application/json
{
  • "real_time_stream": {
    },
  • "limits": {
    }
}
Copyright © Wowza Video. All right reserved.