Atlas
Admin — Usage

Combined usage dashboard

Returns a combined dashboard payload: current period usage, plan limits, up to 31 daily history points (today + past 30 days), and per-user breakdown (top 50).

GET
/api/v1/admin/usage/summary

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3001/api/v1/admin/usage/summary"
{
  "workspaceId": "string",
  "current": {
    "queryCount": 0,
    "tokenCount": 0,
    "activeUsers": 0,
    "periodStart": "string",
    "periodEnd": "string"
  },
  "plan": {
    "tier": "string",
    "displayName": "string",
    "trialEndsAt": "string"
  },
  "limits": {
    "queriesPerMonth": 0,
    "tokensPerMonth": 0,
    "maxMembers": 0,
    "maxConnections": 0
  },
  "history": [
    {
      "id": "string",
      "workspace_id": "string",
      "period": "string",
      "period_start": "string",
      "query_count": 0,
      "token_count": 0,
      "active_users": 0,
      "storage_bytes": 0,
      "updated_at": "string",
      "property1": null,
      "property2": null
    }
  ],
  "users": [
    {
      "user_id": "string",
      "query_count": 0,
      "token_count": 0,
      "login_count": 0
    }
  ],
  "hasStripe": true
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on