Stream Targets

Operations related to stream target analytics, including CDN usage and viewer data.

Fetch usage for all stream targets

(Available from version 1.4) This operation returns detailed CDN usage data for all stream targets 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 stream targets)

An array of stream targets 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/stream_targets
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets"
Response samples
application/json
{
  • "stream_targets": [
    ],
  • "pagination": {
    },
  • "limits": {
    }
}

Fetch usage for a single stream target

(Available from version 1.4) 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

include
string

Specify the data you want returned in the response. You can send a comma-separated list of values.

Valid value is: trend.

Example: trend

Responses
200

Success

Response Schema: application/json
object (stream_target)
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/stream_targets/{id}
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets/2adffc17"
Response samples
application/json
{
  • "stream_target": {
    },
  • "limits": {
    }
}

Fetch stream target usage summary

(Available from version 1.4) This operation returns a summary of CDN usage for all stream targets 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.

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 (summary)
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/stream_targets/summary
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets/summary"
Response samples
application/json
{
  • "summary": {
    },
  • "limits": {
    }
}

(Deprecated) Fetch stream target usage by country

The GET /usage/stream_targets/{id}/countries operation is deprecated and no longer available. To retrieve CDN usage data for a specific stream target by country, use GET /analytics/viewers/stream_targets/{id} endpoint.

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 (countries)
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/stream_targets/{id}/countries
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets/2adffc17/countries"
Response samples
application/json
{
  • "countries": [
    ],
  • "limits": {
    }
}

(Deprecated) Fetch stream target usage by rendition

The GET /usage/stream_targets/{id}/renditions operation is deprecated and no longer available. To retrieve CDN usage data for a specific stream target, use GET /analytics/viewers/stream_targets/{id} endpoint.

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 (renditions)
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/stream_targets/{id}/renditions
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets/2adffc17/renditions"
Response samples
application/json
{
  • "renditions": [
    ],
  • "limits": {
    }
}

(Deprecated) Fetch stream target live viewer data

The GET /usage/stream_targets/{id}/live operation is deprecated and no longer available. To retrieve live viewer data for a stream target, use GET /analytics/viewers/stream_targets/{id} endpoint.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the stream target.

Responses
200

Success

Response Schema: application/json
object (stream_target)
id
string <int32>

The unique alphanumeric string that identifies the stream target.

unique_viewers
integer <int32>

The total number of unique viewers to download at least one chunk of the stream at the target (for HTTP streams). A unique viewer is a single IP address; multiple users that share the same IP address are counted once.

object (countries)

(Available since 1.8) An array of viewer countries.

object (Array of viewer trends)

(Available since 1.8) An array of viewer trend data. Returns one data point per minute for the past hour.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/stream_targets/{id}/live
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.11/usage/stream_targets/2adffc17/live"
Response samples
application/json
{
  • "stream_target": {
    }
}
© 2007-2024 Wowza Media Systems, ™ LLC. All rights reserved.   Security & Privacy Policy | Legal | System Status