Get monthly metrics

GET

/v2/organizations/{organization}/projects/{project}/metrics/monthly

const url = 'https://dashboard.quantcdn.io/v2/organizations/example/projects/example/metrics/monthly?timestamp_format=iso8601';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.quantcdn.io/v2/organizations/example/projects/example/metrics/monthly?timestamp_format=iso8601'

Returns the last 12 months of monthly metrics data

Authorizations

bearerAuth

Parameters

Path Parameters

organization

required

string

Organization identifier

project

required

string

Project identifier

Query Parameters

domain

string

Filter by domain ID or domain name

metrics[]

Array<string>

Allowed values: hits bytes edge_resp_header_bytes bereq_body_bytes bereq_header_bytes bandwidth edge_hit_ratio edge_hit_requests edge_miss_requests origin_fetches origin_fetch_resp_body_bytes origin_fetch_resp_header_bytes origin_offload status_1xx status_2xx status_3xx status_4xx status_5xx origin_status_1xx origin_status_2xx origin_status_3xx origin_status_4xx origin_status_5xx

Metrics to return (default: hits, bytes). Use the /metrics/available endpoint to list all metrics by category.

timestamp_format

string

default: iso8601

Allowed values: iso8601 unix

Timestamp format in response

Responses

200

Monthly metrics data

application/json

object

meta

required

object

period

required

The period type for this data

string

Allowed values: hourly daily monthly

granularity

required

The granularity of data points

string

Allowed values: minute day month

start_time

required

Start time of the data range (ISO8601 or Unix timestamp based on timestamp_format parameter)

string

end_time

required

End time of the data range (ISO8601 or Unix timestamp based on timestamp_format parameter)

string

metrics

required

List of metrics included in the response

Array<string>

domain

Domain filter applied (if any)

string

nullable

data

required

Metrics data keyed by metric name

object

key

additional properties

object

series

required

Time series data points

Array<object>

object

timestamp

required

One of:

string
integer

ISO8601 timestamp

string format: date-time

value

required

Metric value at this timestamp

number

period_total

required

Total value for the period

number

all_time_total

required

All-time total value

number

period_average

required

Average value per time unit in the period

number format: float

Example

{
  "meta": {
    "period": "hourly",
    "granularity": "minute",
    "start_time": "2026-01-29T12:00:00+00:00",
    "end_time": "2026-01-29T13:00:00+00:00",
    "metrics": [
      "hits",
      "bytes"
    ],
    "domain": null
  },
  "data": {
    "hits": {
      "series": [
        {
          "timestamp": "2026-01-29T12:00:00+00:00",
          "value": 150
        },
        {
          "timestamp": "2026-01-29T12:01:00+00:00",
          "value": 142
        }
      ],
      "period_total": 8523,
      "all_time_total": 1284567,
      "period_average": 142.05
    },
    "bytes": {
      "series": [
        {
          "timestamp": "2026-01-29T12:00:00+00:00",
          "value": 1520576
        },
        {
          "timestamp": "2026-01-29T12:01:00+00:00",
          "value": 1423456
        }
      ],
      "period_total": 91234567,
      "all_time_total": 12845670000,
      "period_average": 1520576.12
    }
  }
}

400

Invalid metric requested

404

No domains found or domain not found