docs/HistoricalApi.md in fastly-7.2.2 vs docs/HistoricalApi.md in fastly-8.0.0
- old
+ new
@@ -22,11 +22,11 @@
## `get_hist_stats()`
```ruby
-get_hist_stats(opts): <HistoricalResponse> # Get historical stats
+get_hist_stats(opts): <HistoricalStatsByServiceResponse> # Get historical stats
```
Fetches historical stats for each of your Fastly services and groups the results by service ID.
### Examples
@@ -58,18 +58,18 @@
| **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. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
### Return type
-[**HistoricalResponse**](HistoricalResponse.md)
+[**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_hist_stats_aggregated()`
```ruby
-get_hist_stats_aggregated(opts): <HistoricalAggregateResponse> # Get aggregated historical stats
+get_hist_stats_aggregated(opts): <HistoricalStatsAggregatedResponse> # Get aggregated historical stats
```
Fetches historical stats information aggregated across all of your Fastly services.
### Examples
@@ -101,18 +101,18 @@
| **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. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
### Return type
-[**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
+[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_hist_stats_field()`
```ruby
-get_hist_stats_field(opts): <HistoricalFieldResponse> # Get historical stats for a single field
+get_hist_stats_field(opts): <HistoricalStatsByServiceResponse> # 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.
### Examples
@@ -146,18 +146,18 @@
| **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. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
### Return type
-[**HistoricalFieldResponse**](HistoricalFieldResponse.md)
+[**HistoricalStatsByServiceResponse**](HistoricalStatsByServiceResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_hist_stats_service()`
```ruby
-get_hist_stats_service(opts): <HistoricalAggregateResponse> # Get historical stats for a single service
+get_hist_stats_service(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service
```
Fetches historical stats for a given service.
### Examples
@@ -191,18 +191,18 @@
| **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. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
### Return type
-[**HistoricalAggregateResponse**](HistoricalAggregateResponse.md)
+[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_hist_stats_service_field()`
```ruby
-get_hist_stats_service_field(opts): <HistoricalFieldAggregateResponse> # Get historical stats for a single service/field combination
+get_hist_stats_service_field(opts): <HistoricalStatsAggregatedResponse> # Get historical stats for a single service/field combination
```
Fetches the specified field from the historical stats for a given service.
### Examples
@@ -238,11 +238,11 @@
| **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. * `africa_std` - Africa. * `southamerica_std` - South America. | [optional] |
### Return type
-[**HistoricalFieldAggregateResponse**](HistoricalFieldAggregateResponse.md)
+[**HistoricalStatsAggregatedResponse**](HistoricalStatsAggregatedResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_regions()`
@@ -277,11 +277,11 @@
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_usage()`
```ruby
-get_usage(opts): <HistoricalUsageAggregateResponse> # Get usage statistics
+get_usage(opts): <HistoricalUsageAggregatedResponse> # 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).
### Examples
@@ -309,10 +309,10 @@
| **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)
+[**HistoricalUsageAggregatedResponse**](HistoricalUsageAggregatedResponse.md)
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to README]](../../README.md)
## `get_usage_month()`