Transcoders

Operations related to transcoder analytics.

Fetch usage for all transcoders

This operation shows the amount of usage (egress) for all transcoders in the account. The default time frame is from the last billing date to the end of the 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

page
integer

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Video REST API.

per_page
integer

For use with the page 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
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/transcoders
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.10/usage/transcoders"
Response samples
application/json
{
  • "transcoders": [
    ],
  • "pagination": {
    },
  • "limits": {
    }
}

Fetch usage for a single transcoder

(Available from version 1.4) This operation shows the amount of usage (egress) for a specific transcoder. The default time frame is from the last billing date to the end of the current day.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

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
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

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

Fetch transcoder usage by country

(Available from version 1.8) This operation returns CDN usage details for a specific transcoder by country. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

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/transcoders/{id}/countries
Request samples 
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.10/usage/transcoders/2adffc17/countries"
Response samples
application/json
{
  • "countries": [
    ],
  • "limits": {
    }
}

Fetch transcoder usage summary

(Available from version 1.4) This operation shows a summary of the amount of usage (egress) for all transcoders in the account. The default time frame is from the last billing date to the end of the 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
object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

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

Fetch trend data for a transcoder

(Available from version 1.8) This operation returns trend data for the CDN usage of a transcoder.

The granularity of sampled data changes based on the from and to query values you use:

  1. Requests made for data within the past 30 days, return the following sample intervals:

    • 0 minutes to 3 hours - Samples returned per minute
    • 3 hours, 1 second to 24 hours - Samples returned per hour
    • 24 hours, 1 second to 90 days - Samples returned per day

  2. Requests made for data beyond the past 30 days, always return sample intervals per hour.

Defaults: from = last billing date, to = end of current day

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

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 (Array of trends)

An array of trend data

object

The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

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

Fetch transcoder live viewer data

(Available from version 1.8) This operation returns the number of current viewers for a transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

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

The unique alphanumeric string that identifies the transcoder.

unique_viewers
integer <int32>

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

object (countries)

An array of viewer countries.

object (Array of viewer trends)

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