The Fastly historical Stats API allows you to programmatically retrieve historical caching statistics derived from your Fastly services. You can use these metrics to help you optimize your site’s data caching and analyze your site’s traffic.
The base endpoint for the Stats API is
https://api.fastly.com/. All URLs are relative to that endpoint. All requests must be sent over HTTPS.
Here's an example using the command-line tool cURL:
1 curl -H "Fastly-Key: YOUR_FASTLY_TOKEN" https://api.fastly.com/stats
Availability of Data
As a general rule, minutely, hourly, and daily data will each be delayed by approximately 10 to 15 minutes from the current time due to the time it takes to collect and process historical data. In addition, the current hour and current day will only return partial results because the data is still being incrementally aggregated for that time period, which isn’t complete.
IMPORTANT: You cannot retrieve minutely historical statistics data older than 90 days from the current date. Contact firstname.lastname@example.org to discuss your minutely data needs.
Query Options (Time Range, Sampling Rate, and Regions)
There are four query parameters that you can use to specify what information is returned by the stats API. The
to parameters control the window over which you want to fetch stats information. The
by controls the sampling rate (day, hour, or minute). And the
region parameter allows you to restrict the result set to a particular region.
to parameters are exact times that control the window over which to fetch historical statistics. By default you can use Unix timestamps when specifying these parameters, but many forms of human readable inputs are also available, such as:
Two weeks ago
Date parsing is performed using the Chronic ruby library; for the most detailed information on exactly what formats are available please visit the gem's GitHub page (https://github.com/mojombo/chronic).
Let's see some examples:
When the time of day is not specified, the Stats API assumes 12pm. To specify a midnight to midnight range, you would use
from=1/1/2013 00:00&to=2/1/2013 00:00, before encoding).
from parameter is "inclusive" and the
to parameter is "exclusive". This means that we will return only rows with recorded times that match the following inequality:
1 from <= recorded < to
NOTE: We store historical stats information using UTC, and not local time zones. This means that we will use the UTC interpretations of your inputs when querying stats information.
by parameter allows you to control the sampling rate
used to produce the result set from querying the Stats API. There are
three values that can be set:
minute- Stats will be sampled by minute for each recorded minute in the specified window
hour- Sample by hour within the specified window
day- Sample by day within the specified window
If you do not provide a
by parameter in your query it will default to 'day'. Each sampling rate also specifies default
from parameters if you omit them:
Each value for the
by parameter has associated defaults for the
from parameters if they are omitted, here's an overview:
It is important to remember the following conversions when performing queries:
- 1 day = 24 hours
- 1 hour = 60 minutes
- 1 day = 60 * 24 = 1,440 minutes
When changing the sampling rate via the
by parameter you can accidentally ask for very large data sets if you have defined
from parameters. We will not process exceedingly large queries. Please refer to the Response Format section below for more details.
The Stats API also allows you to limit the scope of your query by restricting it to a particular region. This is achieved via the use of the
region parameter. Currently the following regions are supported:
usa- Restricts the query to statistics reported by POPs in the continental United States
europe- Restricts the query to statistics reported by POPs in Europe
anzac- Restricts the query to statistics reported by POPs in Australia and New Zealand
asia- Restricts the query to statistics reported by POPs in Asia
asia_india- Restricts the query to statistics reported by POPs in India
latam- Restricts the query to statistics reported by POPs in Brazil
south_africa- Restricts the query to statistics reported by POPs in southern Africa
southamerica_std- Restricts the query to statistics reported by POPs in South America
Usage is exceedingly simple, let's look at some examples:
The following endpoint provides a complete list of all available regions:
To make it easier to understand how a query is being processed we use a specific JSON response format. Here is an example:
Each of the fields denotes the following:
status- Whether or not we were able to successfully execute the query
meta- Meta information about the scope of the query in a human readable format
msg- If the query was not successful this will provide a string that explains why
data- This contains the actual results of the query that we processed