Get statistics as time series

Retrieve statistics data as a time series. The from and to parameters are rounded down and up according to the granularity. This means that if the granularity is set to 1h, the from and to parameters will be rounded down and up to the nearest hour, respectively. If the granularity is set to 1d, the from and to parameters will be rounded down and up to the nearest day, respectively. The response will include explicit 0 values for any missing data points.

GET /waap/v1/statistics/series

Get statistics as time series

cURL

curl --request GET \
  --url https://api.gcore.com/waap/v1/statistics/series \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/waap/v1/statistics/series"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/waap/v1/statistics/series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gcore.com/waap/v1/statistics/series",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gcore.com/waap/v1/statistics/series"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/waap/v1/statistics/series")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/waap/v1/statistics/series")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "total_bytes": [
    {
      "date_time": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ],
  "total_requests": [
    {
      "date_time": "2023-11-07T05:31:56Z",
      "value": 123
    }
  ]
}

{
  "type": "http-bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Invalid domain name: ''''"
}

{
  "detail": "Auth token is missing or invalid"
}

{
  "detail": "Permission denied"
}

{
  "type": "http-not-found",
  "title": "Not Found",
  "status": 404,
  "detail": "The resource is not found"
}

{
  "type": "request-validation-failed",
  "title": "Request validation error.",
  "status": 422,
  "detail": "One or more fields have validation errors.",
  "errors": [
    {
      "loc": [
        "body",
        "name"
      ],
      "detail": "Input should be a valid string"
    },
    {
      "loc": [
        "body",
        "date"
      ],
      "detail": "Field required"
    },
    {
      "loc": [
        "query",
        "limit"
      ],
      "detail": "Field required"
    }
  ]
}

{
  "type": "internal-server-error",
  "title": "Internal server error.",
  "status": 500,
  "detail": "An unexpected condition was encountered which prevented the server from fulfilling the request."
}

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

from · string<date-time> · required

Beginning of the requested time period (ISO 8601 format, UTC)

Example:

"2024-12-14T12:00:00Z"

to · string<date-time> · required

End of the requested time period (ISO 8601 format, UTC)

Example:

"2024-12-14T12:00:00Z"

granularity · enum<string> · required

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

Available options: 1h, 1d

metrics · enum<string>[] · required

List of metric types to retrieve statistics for.

Available options: total_bytes, total_requests

Response

200

application/json

Successful Response

Response model for the statistics series

total_bytes · StatisticItem · object[] | null

Will be returned if total_bytes is requested in the metrics parameter

Show child attributes

total_requests · StatisticItem · object[] | null

Will be included if total_requests is requested in the metrics parameter

Show child attributes