Skip to main content
GET
/
cdn
/
statistics
/
series
CDN resource statistics
curl --request GET \
  --url https://api.gcore.com/cdn/statistics/series \
  --header 'Authorization: <api-key>'
{
  "resource": {
    "1": {
      "region": {
        "asia": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                17329220573
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                17384617989
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                17384617989
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                55397416
              ]
            ]
          }
        },
        "cis": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                234582406061
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                234677982848
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                234677982848
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                95576787
              ]
            ]
          }
        },
        "eu": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                243212514764
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                243297296511
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                243297296511
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                84781747
              ]
            ]
          }
        },
        "latam": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                59819837564
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                59927133387
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                59927133387
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                107295823
              ]
            ]
          }
        },
        "me": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                13643432427
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                13644762375
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                13644762375
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                1329948
              ]
            ]
          }
        },
        "na": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                234004049506
              ]
            ],
            "total_bytes": [
              [
                1543622400,
                234655863540
              ]
            ],
            "backblaze_bytes": [
              [
                1543622400,
                234655863540
              ]
            ],
            "upstream_bytes": [
              [
                1543622400,
                651814034
              ]
            ]
          }
        }
      }
    },
    "4777": {
      "region": {
        "au": {
          "metrics": {
            "sent_bytes": [
              [
                1543622400,
                490800672
              ]
            ]
          }
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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
string
required

Service name. Possible value:

  • CDN
​
from
string
required

Beginning of the requested time period (ISO 8601/RFC 3339 format, UTC.)

​
to
string
required

End of the requested time period (ISO 8601/RFC 3339 format, UTC.)

​
granularity
string
required

Duration of the time blocks into which the data will be divided. Possible values:

  • 1m - available only for up to 1 month in the past.
  • 5m
  • 15m
  • 1h
  • 1d
​
metrics
string
required

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 and sent_bytes combined.
  • cdn_bytes – sent_bytes and shield_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 upstream response_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. Metrics upstream_response_time and request_time should be requested separately from other metrics
​
group_by
string

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 CNAMEs. To request multiple values, use: * &group_by=region&group_by=resource
​
countries
string

Names of countries for which data should be displayed. English short name from [ISO 3166 standard][1] without the definite article ("the") should be used. [1]: https://www.iso.org/obp/ui/#search/code/ To request multiple values, use: * &countries=france&countries=denmark

​
regions
string

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
​
resource
integer

CDN resource IDs. To request multiple values, use: * &resource=1&resource=2

Response

Successful.

​
resource
object

Resources IDs by which statistics data is grouped.

​
1 (example)
object

ID of CDN resource for which statistics data is shown.

​
region
object

Locations (regions) by which the data is grouped. Possible values:

  • asia – Asia
  • au – Australia
  • cis – CIS (Commonwealth of Independent States)
  • eu – Europe
  • latam – Latin America
  • me – Middle East
  • na – North America
  • africa – Africa
  • sa – South America
​
metrics
object

Types of statistics data. Possible values:

  • upstream_bytes – Traffic in bytes from an origin server to CDN servers or to origin shielding, if 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 and sent_bytes combined.
  • cdn_bytes – sent_bytes and shield_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 value.
  • cache_hit_requests_ratio – Share of sending cached content. Formula: responses_hit / requests.
  • shield_traffic_ratio – Origin shielding efficiency: how much more traffic is sent from the origin shielding than from the origin. Formula: (shield_bytes - upstream_bytes) / shield_bytes.
  • 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 upstream response_time_ contains several indications for one request (when there is more than one origin,) we summarize them. When aggregating several queries, the average is calculated. Metrics upstream_response_time and request_time should be requested separately from other metrics
​
upstream_bytes
integer[]

Bytes from the upstream to the CDN servers. Represented by two values:

  • 1543622400 — Time in the UNIX timestamp when statistics were received.
  • 17329220573 — Bytes.
​
sent_bytes
integer[]

Bytes from CDN servers to the end-users. Represented by two values:

  • 1543622400 — Time in the UNIX timestamp when statistics were received.
  • 17329220573 — Bytes.
​
total_bytes
integer[]

Upstream bytes and sent_bytes combined. Represented by two values:

  • 1543622400 — Time in the UNIX timestamp when statistics were received.
  • 17329220573 — Bytes.
​
backblaze_bytes
integer[]

BackBlaze bytes from Backblaze origin. Represented by two values: * 1543622400 — Time in the UNIX timestamp when statistics were received. * 17329220573 — Bytes.