From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

FASTLY / WebService-Fastly-9.01 / docs / OriginInspectorHistoricalApi.md

WebService::Fastly::OriginInspectorHistoricalApi

Load the API package


            

              
              
use WebService::Fastly::Object::OriginInspectorHistoricalApi;

[!NOTE] All URIs are relative to https://api.fastly.com

Method | HTTP request | Description ------ | ------------ | ----------- get_origin_inspector_historical | GET /metrics/origins/services/{service_id} | Get historical origin data for a service

get_origin_inspector_historical

HistoricalOriginsResponse get_origin_inspector_historical(service_id => $service_id, start => $start, end => $end, downsample => $downsample, metric => $metric, group_by => $group_by, limit => $limit, cursor => $cursor, region => $region, datacenter => $datacenter, host => $host)

Get historical origin data for a service

Fetches historical origin metrics for a given Fastly service, optionally filtering and grouping the results by origin host, region, or POP.

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::OriginInspectorHistoricalApi;
my $api_instance = WebService::Fastly::OriginInspectorHistoricalApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $start = 2021-08-01T00:00:00.000Z; # string | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
my $end = 2020-08-02T00:00:00.000Z; # string | A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided `downsample` value.
my $downsample = hour; # string | Duration of sample windows.
my $metric = resp_body_bytes,status_2xx; # string | The metrics to retrieve. Multiple values should be comma-separated.
my $group_by = host; # string | Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, `group_by=host` will return one timeseries for every origin host, as a total across all POPs. 
my $limit = '100'; # string | Number of results per page. The maximum is 200.
my $cursor = "cursor_example"; # string | Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
my $region = usa; # string | Limit query to one or more specific geographic regions. Values should be comma-separated. 
my $datacenter = SJC,STP; # string | Limit query to one or more specific POPs. Values should be comma-separated.
my $host = origin_1,origin_2; # string | Limit query to one or more specific origin hosts. Values should be comma-separated.
eval {
    my $result = $api_instance->get_origin_inspector_historical(service_id => $service_id, start => $start, end => $end, downsample => $downsample, metric => $metric, group_by => $group_by, limit => $limit, cursor => $cursor, region => $region, datacenter => $datacenter, host => $host);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OriginInspectorHistoricalApi->get_origin_inspector_historical: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | start | string| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value. | [optional] end | string| A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value. | [optional] downsample | string| Duration of sample windows. | [optional] [default to 'hour'] metric | string| The metrics to retrieve. Multiple values should be comma-separated. | [optional] [default to 'responses'] group_by | string| Dimensions to return in the query. Multiple dimensions may be separated by commas. For example, group_by=host will return one timeseries for every origin host, as a total across all POPs. | [optional] limit | string| Number of results per page. The maximum is 200. | [optional] [default to '100'] cursor | string| Cursor value from the next_cursor field of a previous response, used to retrieve the next page. To request the first page, this should be empty. | [optional] region | string| Limit query to one or more specific geographic regions. Values should be comma-separated. | [optional] datacenter | string| Limit query to one or more specific POPs. Values should be comma-separated. | [optional] host | string| Limit query to one or more specific origin hosts. Values should be comma-separated. | [optional]

Return type

HistoricalOriginsResponse

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]