Usage Summary | OnePin

{
  "data": {
    "range": "30d",
    "activity_view": "daily",
    "timezone": "America/New_York",
    "period": {
      "start": "2024-04-01T00:00:00Z",
      "end": "2024-04-30T23:59:59Z"
    },
    "credits": {
      "used": 1250,
      "quota": 5000,
      "percent": 25
    },
    "characters": {
      "total": 350000
    },
    "lines": {
      "total": 17500,
      "avg_chars_per_line": 20
    },
    "runs": {
      "total": 1200,
      "completed": 1150,
      "failed": 30,
      "cancelled": 10,
      "running": 5,
      "pending": 5
    },
    "activity": {
      "view": "daily",
      "bucket_unit": "day",
      "range_label": "Last 30 days",
      "total": 17500,
      "avg": 583.3,
      "buckets": [
        {
          "label": "2024-03-31",
          "start": "2024-03-31T00:00:00Z",
          "end": "2024-03-31T23:59:59Z",
          "credits": 40,
          "characters": 12000,
          "lines": 600,
          "runs": 45
        }
      ],
      "peak": {
        "value": 900,
        "label": "2024-04-15",
        "start": "2024-04-15T00:00:00Z",
        "end": "2024-04-15T23:59:59Z"
      }
    },
    "daily": [
      {
        "date": "2024-04-01",
        "credits": 35,
        "characters": 11000,
        "lines": 550,
        "runs": 40
      }
    ]
  },
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "timestamp": "2024-04-30T23:59:59Z"
  }
}

Return workspace usage totals plus tab-specific aggregate activity buckets.

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Headers

X-Workspace-Idstring or nullOptional

Query parameters

rangeenumOptionalDefaults to 30d

Rolling local calendar-day range.

Allowed values:

activity_viewenumOptionalDefaults to daily

Activity chart view: daily=7 local days, weekly=12 Monday-start weeks, monthly=12 months.

Allowed values:

timezonestringOptionalDefaults to UTC

IANA timezone for local day bucketing.

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

$	curl https://api.onepin.ai/api/v1/usage/summary \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"