VOD Streams

Operations related to video on demand (VOD) stream analytics.

Fetch usage for all VOD streams

(Available from version 1.5) This operation returns detailed CDN usage data for all VOD streams in the account. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content.

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

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

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

An array of VOD 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.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams"

Response samples

Content type
application/json
{
  • "vod_streams": [
    ],
  • "pagination": {
    },
  • "limits": {
    }
}

Fetch egress for all VOD streams

(Available from version 1.7) This operation returns egress usage for all VOD streams in the account. For VOD streams, egress is the traffic generated by Wowza CDN on Fastly pulling the VOD asset from storage.

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

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

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

An array of VOD streams and the details of their egress usage.

object

Page information for the results generated by the query.

object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/egress"

Response samples

Content type
application/json
{
  • "vod_streams": [
    ],
  • "pagination": {
    },
  • "limits": {
    }
}

Fetch usage for a single VOD stream

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

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

Response Schema: application/json
object (vod_stream)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/1ndgfc11"

Response samples

Content type
application/json
{
  • "vod_stream": {
    },
  • "limits": {
    }
}

Fetch egress for a single VOD stream

(Available from version 1.7) This operation returns egress usage for a specific VOD stream. For VOD streams, egress is the traffic generated by Wowza CDN on Fastly pulling the VOD asset from storage.

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

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

Response Schema: application/json
object (vod_stream)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/egress/1ndgfc11"

Response samples

Content type
application/json
{
  • "vod_stream": {
    },
  • "limits": {
    }
}

Fetch VOD stream usage summary

(Available from version 1.5) This operation returns a summary of CDN usage for all VOD streams in the account. CDN usage is the amount of data that went through every Fastly stream target, including unique viewers, viewing time, and bytes of content.

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

Response Schema: application/json
object (summary)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/summary"

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "limits": {
    }
}

Fetch VOD stream usage by country

(Available from version 1.5) This operation returns CDN usage details for a specific VOD stream 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.

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

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

Responses

Response Schema: application/json
object (countries)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/1ndgfc11/countries"

Response samples

Content type
application/json
{
  • "countries": [
    ],
  • "limits": {
    }
}

Fetch VOD stream usage by rendition

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

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

Response Schema: application/json
object (renditions)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/1ndgfc11/renditions"

Response samples

Content type
application/json
{
  • "renditions": [
    ],
  • "limits": {
    }
}

Fetch VOD stream egress summary

(Available from version 1.7) This operation returns a summary of egress usage for all VOD streams in the account. For VOD streams, egress is the traffic generated by Wowza CDN on Fastly pulling the VOD asset from storage.

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

Response Schema: application/json
object (summary)
object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/egress/summary"

Response samples

Content type
application/json
{
  • "summary": {
    },
  • "limits": {
    }
}

Fetch trend data for a VOD stream

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

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

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

Response Schema: application/json
object (Array of trends)

An array of trend data

object

The time frame represented in the response.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_stream/2adffc17/trend"

Response samples

Content type
application/json
{
  • "trend": [
    ],
  • "limits": {
    }
}

Fetch VOD stream live viewer data

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

Responses

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

The unique alphanumeric string that identifies the VOD stream.

unique_viewers
integer <int32>

The total number of unique viewers to download at least one chunk of the VOD 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.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/usage/vod_streams/2adffc17/live"

Response samples

Content type
application/json
{
  • "vod_stream": {
    }
}