lib/fastly/api/historical_api.rb in fastly-4.0.0.alpha2 vs lib/fastly/api/historical_api.rb in fastly-4.0.0.alpha3
- old
+ new
@@ -2,12 +2,12 @@
#Fastly API
#Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://developer.fastly.com/reference/api/)
The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
-
=end
require 'cgi'
module Fastly
@@ -17,24 +17,24 @@
def initialize(api_client = ApiClient.default)
@api_client = api_client
end
# Get historical stats
# Fetches historical stats for each of your Fastly services and groups the results by service ID.
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalResponse]
def get_hist_stats(opts = {})
data, _status_code, _headers = get_hist_stats_with_http_info(opts)
data
end
# Get historical stats
# Fetches historical stats for each of your Fastly services and groups the results by service ID.
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalResponse, Integer, Hash)>] HistoricalResponse data, response status code and response headers
def get_hist_stats_with_http_info(opts = {})
if @api_client.config.debugging
@@ -93,24 +93,24 @@
return data, status_code, headers
end
# Get aggregated historical stats
# Fetches historical stats information aggregated across all of your Fastly services.
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalAggregateResponse]
def get_hist_stats_aggregated(opts = {})
data, _status_code, _headers = get_hist_stats_aggregated_with_http_info(opts)
data
end
# Get aggregated historical stats
# Fetches historical stats information aggregated across all of your Fastly services.
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
def get_hist_stats_aggregated_with_http_info(opts = {})
if @api_client.config.debugging
@@ -170,12 +170,12 @@
end
# Get historical stats for a single field
# Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
# @option opts [String] :field Name of the stats field. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalFieldResponse]
def get_hist_stats_field(opts = {})
data, _status_code, _headers = get_hist_stats_field_with_http_info(opts)
@@ -183,12 +183,12 @@
end
# Get historical stats for a single field
# Fetches the specified field from the historical stats for each of your services and groups the results by service ID.
# @option opts [String] :field Name of the stats field. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalFieldResponse, Integer, Hash)>] HistoricalFieldResponse data, response status code and response headers
def get_hist_stats_field_with_http_info(opts = {})
if @api_client.config.debugging
@@ -253,12 +253,12 @@
end
# Get historical stats for a single service
# Fetches historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalAggregateResponse]
def get_hist_stats_service(opts = {})
data, _status_code, _headers = get_hist_stats_service_with_http_info(opts)
@@ -266,12 +266,12 @@
end
# Get historical stats for a single service
# Fetches historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalAggregateResponse, Integer, Hash)>] HistoricalAggregateResponse data, response status code and response headers
def get_hist_stats_service_with_http_info(opts = {})
if @api_client.config.debugging
@@ -337,12 +337,12 @@
# Get historical stats for a single service/field combination
# Fetches the specified field from the historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :field Name of the stats field. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [HistoricalFieldAggregateResponse]
def get_hist_stats_service_field(opts = {})
data, _status_code, _headers = get_hist_stats_service_field_with_http_info(opts)
@@ -351,12 +351,12 @@
# Get historical stats for a single service/field combination
# Fetches the specified field from the historical stats for a given service.
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
# @option opts [String] :field Name of the stats field. (required)
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @option opts [String] :by Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. (default to 'day')
# @option opts [String] :region Limit query to a specific geographic region. One of: * `usa` - North America. * `europe` - Europe. * `anzac` - Australia and New Zealand. * `asia` - Asia. * `asia_india` - India. * `asia_southkorea` - South Korea ([from Aug 2, 2021](https://status.fastly.com/incidents/f83m70cqm258)) * `africa_std` - Africa. * `southamerica_std` - South America.
# @return [Array<(HistoricalFieldAggregateResponse, Integer, Hash)>] HistoricalFieldAggregateResponse data, response status code and response headers
def get_hist_stats_service_field_with_http_info(opts = {})
if @api_client.config.debugging
@@ -481,22 +481,22 @@
return data, status_code, headers
end
# Get usage statistics
# Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [`/stats/aggregate`](#get-hist-stats-aggregated).
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @return [HistoricalUsageAggregateResponse]
def get_usage(opts = {})
data, _status_code, _headers = get_usage_with_http_info(opts)
data
end
# Get usage statistics
# Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see [`/stats/aggregate`](#get-hist-stats-aggregated).
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @return [Array<(HistoricalUsageAggregateResponse, Integer, Hash)>] HistoricalUsageAggregateResponse data, response status code and response headers
def get_usage_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_usage ...'
end
@@ -608,21 +608,21 @@
return data, status_code, headers
end
# Get usage statistics per service
# Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see [`/stats`](#get-hist-stats) and [`/stats/field/:field`](#get-hist-stats-field).
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @return [HistoricalUsageServiceResponse]
def get_usage_service(opts = {})
data, _status_code, _headers = get_usage_service_with_http_info(opts)
data
end
# Get usage statistics per service
# Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see [`/stats`](#get-hist-stats) and [`/stats/field/:field`](#get-hist-stats-field).
- # @option opts [String] :from Absolute, relative or epoch timestamp. Limits the results returned.
- # @option opts [String] :to Absolute, relative or epoch timestamp. Limits the results returned.
+ # @option opts [String] :from Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the [Chronic Ruby library](https://github.com/mojombo/chronic), such as 'yesterday', or 'two weeks ago'. Default varies based on the value of `by`.
+ # @option opts [String] :to Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. (default to 'now')
# @return [Array<(HistoricalUsageServiceResponse, Integer, Hash)>] HistoricalUsageServiceResponse data, response status code and response headers
def get_usage_service_with_http_info(opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug 'Calling API: HistoricalApi.get_usage_service ...'
end