Get bucket metrics

GET

/object-storage/buckets/:bucket_name/metrics

GET

/v1/object-storage/buckets/:bucket_name/metrics

# 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"

{
  "bucket_name": "<bucket_name>",
  "range": "24h",
  "range_start": "2026-10-25T12:00:00Z",
  "range_end": "2026-10-25T12:00:00Z",
  "totals": {
    "current_storage_bytes": 1,
    "object_count": 1,
    "data_retrieved_bytes": 1,
    "class_a_operations": 1,
    "class_b_operations": 1,
    "total_operations": 1,
    "successful_requests": 1,
    "failed_requests": 1
  },
  "points": [
    {
      "timestamp": "2026-10-25T12:00:00Z",
      "data_retrieved_bytes": 1,
      "class_a_operations": 1,
      "class_b_operations": 1,
      "total_operations": 1,
      "successful_requests": 1,
      "failed_requests": 1,
      "coverage_complete": true
    }
  ],
  "generated_at": "2026-10-25T12:00:00Z",
  "coverage_complete": true
}

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

503

Service Unavailable Error