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

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/usage/transcoders"

Response samples

application/json

{"transcoders": [{"id": "bbrjj3ml",
"name": "transcoder name",
"archived": false,
"transcoder_type": "transcoded",
"billing_mode": "pay_as_you_go",
"egress_bytes": 0,
"egress_seconds": 44,
"egress_seconds_additional_targets": 23
},
{"id": "mertj8nd",
"name": "my other transcoder",
"archived": false,
"transcoder_type": "transcoded",
"billing_mode": "pay_as_you_go",
"egress_bytes": 80384481,
"egress_seconds": 158,
"egress_seconds_additional_targets": 0
}
],
"pagination": {"payload_version": "1.0",
"total_records": 2130,
"page": 3,
"per_page": 3,
"total_pages": 710,
"page_first_index": 6,
"page_last_index": 8
},
"limits": {"from": "2019-10-01T07:00:00.000Z",
"to": "2019-10-16T11:00:00.000Z"
}
}

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

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
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
	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

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/usage/transcoders/2adffc17"

Response samples

application/json

{"transcoder": {"id": "bbrjj3ml",
"name": "transcoder name",
"archived": false,
"transcoder_type": "transcoded",
"billing_mode": "pay_as_you_go",
"egress_bytes": 0,
"egress_seconds": 44,
"egress_seconds_additional_targets": 23,
"viewing_seconds": 90,
"viewing_bytes": 49,
"trend": [{"sampled_at": "2019-10-01T08:00:00.000Z",
"viewing_seconds": 45,
"viewing_bytes": 20
}
]
},
"limits": {"from": "2019-10-01T07:00:00.000Z",
"to": "2019-10-16T11:00:00.000Z"
}
}

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

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

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/usage/transcoders/summary"

Response samples

application/json

{"summary": {"egress_bytes": 3000,
"egress_seconds": 300,
"configurations": [{"transcoder_type": "transcoded",
"billing_mode": "pay_as_you_go",
"egress_bytes": 1000,
"egress_seconds": 200
},
{"transcoder_type": "passthrough",
"billing_mode": "twentyfour_seven",
"egress_bytes": 2000,
"egress_seconds": 100
}
]
},
"limits": {"from": "2019-02-15T00:00:00.000Z",
"to": "2019-09-24T00:00:00.000Z"
}
}