Skip to navigation

Get CDN distribution metrics

Returns traffic, cache and origin metrics of the distribution for the last 24 hours, 7 days or 30 days, as the portal’s Metrics tab shows them. Requires scope: cdn.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# DISTRIBUTION_ID: CDN distribution ID
curl "https://api.ibee.ai/v1/cdn/distributions/$DISTRIBUTION_ID/metrics?workspace_id=$WORKSPACE_ID" \
-H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Path parameters

distribution_idstringRequired>=1 character
CDN distribution ID.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

rangeenumOptionalDefaults to 24h

Time range. Default 24h.

Allowed values:

Response

Metrics returned successfully.
distribution_idstring
rangeenum
Allowed values:
granularityenum
Allowed values:
range_startdatetime
range_enddatetime
trafficobject
cacheobject
pointslist of objects
distribution_namestringOptional
generated_atdatetimeOptional
coverage_completebooleanOptional
originobjectOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error