Skip to navigation

Get bucket metrics

Returns request and storage metrics of the bucket for the last 24 hours or 7 days, as the portal’s Metrics tab shows them. Requires scope: object-storage.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
# BUCKET_NAME: Logical bucket name
curl "https://api.ibee.ai/v1/object-storage/buckets/$BUCKET_NAME/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

bucket_namestringRequired
Logical bucket name.

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

Get bucket metrics succeeded.
bucket_namestring
rangeenum
Allowed values:
range_startdatetime
range_enddatetime
totalsobject
pointslist of objects
generated_atdatetimeOptional
coverage_completebooleanOptional

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