docs/HistoricalApi.md in fastly-4.0.0.alpha2 vs docs/HistoricalApi.md in fastly-4.0.0.alpha3
- old
+ new
@@ -32,12 +32,12 @@
### Examples
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
region: 'usa', # String | 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.
}
begin
@@ -51,12 +51,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
| **region** | **String** | 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. | [optional] |
### Return type
@@ -75,12 +75,12 @@
### Examples
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
region: 'usa', # String | 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.
}
begin
@@ -94,12 +94,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
| **region** | **String** | 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. | [optional] |
### Return type
@@ -119,12 +119,12 @@
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
field: 'hit_ratio', # String | Name of the stats field.
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
region: 'usa', # String | 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.
}
begin
@@ -139,12 +139,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **field** | **String** | Name of the stats field. | |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
| **region** | **String** | 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. | [optional] |
### Return type
@@ -164,12 +164,12 @@
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
region: 'usa', # String | 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.
}
begin
@@ -184,12 +184,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **service_id** | **String** | Alphanumeric string identifying the service. | |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
| **region** | **String** | 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. | [optional] |
### Return type
@@ -210,12 +210,12 @@
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
field: 'hit_ratio', # String | Name of the stats field.
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
by: 'hour', # String | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day.
region: 'usa', # String | 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.
}
begin
@@ -231,12 +231,12 @@
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **service_id** | **String** | Alphanumeric string identifying the service. | |
| **field** | **String** | Name of the stats field. | |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
| **by** | **String** | Duration of sample windows. One of: * `hour` - Group data by hour. * `minute` - Group data by minute. * `day` - Group data by day. | [optional][default to 'day'] |
| **region** | **String** | 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. | [optional] |
### Return type
@@ -287,12 +287,12 @@
### Examples
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
}
begin
# Get usage statistics
result = api_instance.get_usage(opts)
@@ -304,12 +304,12 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
### Return type
[**HistoricalUsageAggregateResponse**](HistoricalUsageAggregateResponse.md)
@@ -367,12 +367,12 @@
### Examples
```ruby
api_instance = Fastly::HistoricalApi.new
opts = {
- from: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
- to: '2020-04-09T18:14:30Z', # String | Absolute, relative or epoch timestamp. Limits the results returned.
+ from: '2020-04-09T18:14:30Z', # String | 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`.
+ to: '2020-04-09T18:14:30Z', # String | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`.
}
begin
# Get usage statistics per service
result = api_instance.get_usage_service(opts)
@@ -384,11 +384,11 @@
### Options
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
-| **from** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
-| **to** | **String** | Absolute, relative or epoch timestamp. Limits the results returned. | [optional] |
+| **from** | **String** | 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`. | [optional] |
+| **to** | **String** | Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as `from`. | [optional][default to 'now'] |
### Return type
[**HistoricalUsageServiceResponse**](HistoricalUsageServiceResponse.md)