Authorizations
API key for authentication. Make sure to include the word apikey
, followed by a single space and then your token.
Example: apikey 1234$abcdef
Query Parameters
Service name.
Possible value:
- CDN
Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)
Examples: * &from=2018-11-01T00:00:00.000 * &from=2018-11-01
End of the requested time period (ISO 8601/RFC 3339 format, UTC.)
Examples: * &to=2018-11-01T00:00:00.000 * &to=2018-11-01
Types of statistics data.
Possible values:
upstream_bytes
– Traffic in bytes from an origin server to CDN servers or to origin shielding when used.sent_bytes
– Traffic in bytes from CDN servers to clients.shield_bytes
– Traffic in bytes from origin shielding to CDN servers.backblaze_bytes
- Traffic in bytes from Backblaze origin.total_bytes
–shield_bytes
,upstream_bytes
andsent_bytes
combined.cdn_bytes
–sent_bytes
andshield_bytes
combined.- requests – Number of requests to edge servers.
responses_2xx
– Number of 2xx response codes.responses_3xx
– Number of 3xx response codes.responses_4xx
– Number of 4xx response codes.responses_5xx
– Number of 5xx response codes.responses_hit
– Number of responses with the header Cache: HIT.responses_miss
– Number of responses with the header Cache: MISS.response_types
– Statistics by content type. It returns a number of responses for content with different MIME types.cache_hit_traffic_ratio
– Formula: 1 -upstream_bytes
/sent_bytes
. We deduct the non-cached traffic from the total traffic amount.cache_hit_requests_ratio
– Formula:responses_hit
/ requests. The share of sending cached content.shield_traffic_ratio
– Formula: (shield_bytes
-upstream_bytes
) /shield_bytes
. The efficiency of the Origin Shielding: how much more traffic is sent from the Origin Shielding than from the origin.image_processed
- Number of images transformed on the Image optimization service.request_time
- Time elapsed between the first bytes of a request were processed and logging after the last bytes were sent to a user.upstream_response_time
- Number of milliseconds it took to receive a response from an origin. If upstreamresponse_time_
contains several indications for one request (in case of more than 1 origin), we summarize them. In case of aggregating several queries, the average of this amount is calculated.95_percentile
- Represents the 95th percentile of network bandwidth usage in bytes per second. This means that 95% of the time, the network resource usage was below this value.max_bandwidth
- The maximum network bandwidth that was used during the selected time represented in bytes per second.min_bandwidth
- The minimum network bandwidth that was used during the selected time represented in bytes per second.
Metrics upstream_response_time
and request_time
should be requested separately from other metrics
Output data grouping.
Possible values:
- resource – Data is grouped by CDN resources IDs.
- region – Data is grouped by regions of CDN edge servers.
- country – Data is grouped by countries of CDN edge servers.
- vhost – Data is grouped by resources CNAME.
To request multiple values, use:
* &group_by
=region&group_by
=resource
Regions for which data is displayed.
Possible values:
- na – North America
- eu – Europe
- cis – Commonwealth of Independent States
- asia – Asia
- au – Australia
- latam – Latin America
- me – Middle East
- africa - Africa
- sa - South America
Names of countries for which data is displayed.
English short name from ISO 3166 standard without the definite article "the" should be used.
To request multiple values, use: * &countries=france&countries=denmark
CDN resources IDs by which statistics data is grouped.
To request multiple values, use: * &resource=1&resource=2
If CDN resource ID is not specified, data related to all CDN resources is returned.
The waу the parameters are arranged in the response.
Possible values:
- true – Flat structure is used.
- false – Embedded structure is used (default.)
Response
Successful.
Resources IDs by which statistics data is grouped.
CDN resource ID for which statistics data is shown.
Regions by which statistics data is grouped.
Region by which statistics data is grouped.
Statistics parameters.
Traffic in bytes from the upstream to CDN servers.
Traffic in bytes from CDN servers to clients.
Upstream bytes and sent_bytes
combined.
Traffic in bytes from Backblaze origin.
Number of requests to edge servers.
Number of 2xx response codes.
Number of 3xx response codes.
Number of 4xx response codes.
Number of 5xx response codes.
Number of responses with the header Cache: HIT.
Number of responses with the header Cache: MISS.
Statistics by content type. It returns a number of responses for content with different MIME types.
Formula: 1 - upstream_bytes
/ sent_bytes
. We deduct the non-cached traffic from the total traffic amount
95 percentile bandwidth value
Minimum bandwidth
Maximum bandwidth