← Receivers

dashboard:usage

dashboard family

Caller's plan usage — calls, agents, limits

Effect
ask
Awaits an outcome — the call returns the response below.
Cost
free
What one call costs, so you can budget before acting.
Reversible
yes
The effect can be undone by a later call.
Idempotent
yes
Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code
Codex
Cursor
Gemini CLI
Claude Desktop
ChatGPT
curl -X POST https://one.ie/api/ask/dashboard:usage \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": {}}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

Takes no arguments.

Response

What comes back from the call.

  • tier string
  • calls_this_month number
  • agents_count number
  • api_limit number
  • agent_limit number
  • loops string[]
  • highways_count number
  • upgrade_url string

Traffic

Every call to dashboard:usage, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names dashboard:usage, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

Agent runtime 1
  • channels/src/tools/analytics.ts:27
CLI 2
  • packages/cli/src/doctor.ts:68
  • packages/cli/src/trade.ts:93
SDK 1
  • packages/sdk/src/client.ts:746
Docs 2
  • one.ie/web/src/content/docs/cli.md:331
  • one.ie/web/src/content/docs/sdk.md:228

Answered by

dashboard:usage one.ie/web/src/lib/resolvers/billing.ts:90 Dispatched through POST /api/ask/dashboard:usage, after the envelope validates the payload.
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tier": {
      "type": "string"
    },
    "calls_this_month": {
      "type": "number"
    },
    "agents_count": {
      "type": "number"
    },
    "api_limit": {
      "type": "number"
    },
    "agent_limit": {
      "type": "number"
    },
    "loops": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "highways_count": {
      "type": "number"
    },
    "upgrade_url": {
      "type": "string"
    }
  },
  "required": [
    "tier",
    "calls_this_month",
    "agents_count",
    "api_limit",
    "agent_limit",
    "loops",
    "highways_count",
    "upgrade_url"
  ]
}