API referenceUsage
Get Organization Usage
Authorization
bearerAuth AuthorizationBearer <token>
Use a project API key for sandbox and runtime routes, or an OpenMetal user access token for account management routes.
In: header
Path Parameters
organization_id*stringFormat
uuidQuery Parameters
from?stringFormat
date-timethrough?stringFormat
date-timeproject_id?stringMatch
^prj_[A-Za-z0-9]+$provider?stringValues
blaxel, cloudflare, codesandbox, daytona, e2b, freestyle, modal, northflank, prime, runloop, vercelbilling_mode?stringValues
all, managed, byokDefaultallstatus?stringcost_provenance?stringValues
provider_reported, provider_metered, estimated_rate_card, unknownsandbox_id?stringMatch
^sbx_[A-Za-z0-9]+$limit?integerRange
1–100Default100Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/usage"{ "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "period": { "from": "2019-08-24T14:15:22Z", "through": "2019-08-24T14:15:22Z", "comparison_from": "2019-08-24T14:15:22Z", "comparison_through": "2019-08-24T14:15:22Z", "timezone": "UTC" }, "summary": { "total_cost": { "current": { "microusd": "string", "usd": "string" }, "previous": { "microusd": "string", "usd": "string" }, "change_percent": 0 }, "managed_cost": { "current": { "microusd": "string", "usd": "string" }, "previous": { "microusd": "string", "usd": "string" }, "change_percent": 0 }, "byok_cost": { "current": { "microusd": "string", "usd": "string" }, "previous": { "microusd": "string", "usd": "string" }, "change_percent": 0 }, "projected_month_end": { "microusd": "string", "usd": "string" } }, "coverage": { "available_percent": 0, "items": [ { "provenance": "provider_reported", "confidence": "high", "cost": { "microusd": "string", "usd": "string" }, "percent": 0 } ], "unavailable_sandbox_count": 0 }, "daily": [ { "date": "2019-08-24", "total_cost": { "microusd": "string", "usd": "string" }, "managed_cost": { "microusd": "string", "usd": "string" }, "byok_cost": { "microusd": "string", "usd": "string" }, "providers": [ { "key": "string", "label": "string", "cost": { "microusd": "string", "usd": "string" } } ], "projects": [ { "key": "string", "label": "string", "cost": { "microusd": "string", "usd": "string" } } ] } ], "by_provider": [ { "provider": "blaxel", "cost": { "microusd": "string", "usd": "string" }, "previous_cost": { "microusd": "string", "usd": "string" }, "change_percent": 0, "share_percent": 0, "managed_cost": { "microusd": "string", "usd": "string" }, "byok_cost": { "microusd": "string", "usd": "string" }, "reported_percent": 0 } ], "by_project": [ { "project_id": "string", "project_name": "string", "project_slug": "string", "cost": { "microusd": "string", "usd": "string" }, "previous_cost": { "microusd": "string", "usd": "string" }, "change_percent": 0, "share_percent": 0, "managed_cost": { "microusd": "string", "usd": "string" }, "byok_cost": { "microusd": "string", "usd": "string" } } ], "top_sandboxes": [ { "sandbox_id": "string", "project_id": "string", "project_name": "string", "project_slug": "string", "provider": "blaxel", "billing_mode": "managed", "status": "requested", "cost": { "microusd": "string", "usd": "string" }, "previous_cost": { "microusd": "string", "usd": "string" }, "change_percent": 0, "provenance": "provider_reported", "confidence": "high", "cost_source": "string" } ], "activity": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "measured_through": "2019-08-24T14:15:22Z", "sandbox_id": "string", "project_id": "string", "project_name": "string", "project_slug": "string", "provider": "blaxel", "billing_mode": "managed", "status": "requested", "cost_delta": { "microusd": "string", "usd": "string" }, "cumulative_cost": { "microusd": "string", "usd": "string" }, "provenance": "provider_reported", "confidence": "high", "cost_source": "string", "rate_card_version": "string" } ], "generated_at": "2019-08-24T14:15:22Z"}