Get Bucket Usage

Get usage and cost metrics.

Analyzes bucket usage and costs including:

• Storage costs (GB-hours)
• Upload operation costs
• Sync operation costs
• Cost breakdown by category

Use Cases:

• Track bucket costs
• Optimize spending
• Forecast future costs
• Cost attribution

Example:

curl -X GET "https://api.mixpeek.com/v1/analytics/buckets/bkt_abc123/usage?group_by=day" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

GET /v1/analytics/buckets/{bucket_id}/usage

Get Bucket Usage

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/analytics/buckets/{bucket_id}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "bucket_id": "<string>",
  "time_range": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "metrics": [
    {
      "time_bucket": "2023-11-07T05:31:56Z",
      "storage_gb_hours": 123,
      "upload_operations": 123,
      "sync_operations": 123,
      "total_credits": 123,
      "estimated_cost_usd": 123
    }
  ],
  "cost_breakdown": {
    "storage_percent": 123,
    "upload_percent": 123,
    "sync_percent": 123,
    "other_percent": 123
  },
  "total_credits": 123,
  "total_cost_usd": 123
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

bucket_id · string · required

Query Parameters

start_date · string<date-time> | null

Start date (UTC)

end_date · string<date-time> | null

End date (UTC)

group_by · string · default: day

Time grouping: hour, day, week, month

Response

200

application/json

Successful Response

Bucket usage and cost analytics response.

bucket_id · string · required

Bucket identifier

time_range · TimeRange · object · required

Query time range

Show child attributes

metrics · UsageMetric · object[] · required

Usage metrics

Show child attributes

cost_breakdown · CostBreakdown · object · required

Cost breakdown

Show child attributes

total_credits · integer · required

Total credits consumed

total_cost_usd · number · required

Total cost in USD