VOD Streams (Usage)

The VOD stream operations are deprecated in 2.0.
Operations related to video on demand (VOD) stream analytics.

Fetch usage for all VOD streams

The VOD stream operations are deprecated in 2.0.

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.

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

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/vod_streams

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/vod_streams"

Response samples

application/json

{"vod_streams": [{"id": "poatq15",
"name": "My VOD Stream on Mar 25, 2021 @ 05:09pm PDT",
"archived": true,
"type": "fastly",
"viewing_seconds": 44925498,
"viewing_bytes": 22886
},
{"id": "nts8765",
"name": "My Other VOD Stream on Mar 26, 2021 @ 01:15pm PDT",
"archived": false,
"type": "fastly",
"viewing_seconds": 593275043,
"viewing_bytes": 22886
}
],
"pagination": {"payload_version": "2.0",
"total_records": 150,
"next_page_key": "1yr9pykn",
"per_page": 10,
"total_pages": 15
},
"limits": {"from": "2021-01-07T00:00:00.000Z",
"to": "2021-10-05T00:00:00.000Z"
}
}

Fetch usage for a single VOD stream

The VOD stream operations are deprecated in 2.0.

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.

Request

path Parameters

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
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 (vod_stream)
	object The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/vod_streams/{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/vod_streams/1ndgfc11"

Response samples

application/json

{"vod_stream": {"id": "tvctq36g",
"name": "My VOD Stream",
"archived": true,
"type": "fastly",
"viewing_seconds": 44925498,
"viewing_bytes": 22886,
"egress_bytes": 1783702,
"egress_seconds": 97058,
"trend": [{"sampled_at": "2019-10-01T08:00:00.000Z",
"viewing_seconds": 45,
"viewing_bytes": 20
}
]
},
"limits": {"from": "2021-01-07T00:00:00.000Z",
"to": "2021-10-05T00:00:00.000Z"
}
}

Fetch VOD stream usage summary

The VOD stream operations are deprecated in 2.0.

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.

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 (summary)
	object The time frame represented in the response.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/usage/vod_streams/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/vod_streams/summary"

Response samples

application/json

{"summary": {"viewing_seconds": 67925498,
"viewing_bytes": 22886,
"egress_seconds": 6348,
"egress_bytes": 1928166892
},
"limits": {"from": "2021-01-07T00:00:00.000Z",
"to": "2021-10-05T00:00:00.000Z"
}
}