Usage Summary | Onepin

{
  "data": {
    "range": "30d",
    "activity_view": "daily",
    "timezone": "America/New_York",
    "period": {
      "start": "2024-04-01T00:00:00Z",
      "end": "2024-05-01T00:00:00Z"
    },
    "credits": {
      "used": 1250,
      "quota": 5000,
      "percent": 25
    },
    "characters": {
      "total": 450000
    },
    "lines": {
      "total": 15000,
      "avg_chars_per_line": 30
    },
    "runs": {
      "total": 320,
      "completed": 300,
      "failed": 10,
      "cancelled": 5,
      "running": 3,
      "pending": 2,
      "paused": 0
    },
    "activity": {
      "view": "daily",
      "bucket_unit": "day",
      "range_label": "Last 30 days",
      "total": 15000,
      "avg": 500,
      "buckets": [
        {
          "label": "Apr 1",
          "start": "2024-04-01T00:00:00Z",
          "end": "2024-04-02T00:00:00Z",
          "credits": 40,
          "characters": 14000,
          "lines": 450,
          "runs": 10
        },
        {
          "label": "Apr 2",
          "start": "2024-04-02T00:00:00Z",
          "end": "2024-04-03T00:00:00Z",
          "credits": 38,
          "characters": 13500,
          "lines": 430,
          "runs": 9
        }
      ],
      "peak": {
        "value": 600,
        "label": "Apr 15",
        "start": "2024-04-15T00:00:00Z",
        "end": "2024-04-16T00:00:00Z"
      }
    },
    "daily": [
      {
        "date": "2024-04-01",
        "credits": 40,
        "characters": 14000,
        "lines": 450,
        "runs": 10
      },
      {
        "date": "2024-04-02",
        "credits": 38,
        "characters": 13500,
        "lines": 430,
        "runs": 9
      }
    ]
  },
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "timestamp": "2024-04-30T23:59:59Z"
  }
}

Return aggregated usage totals and activity chart data for the workspace.

Combines credit consumption, character and line counts, and workflow run statistics for the requested rolling window (range) with a chart-ready activity series (activity) bucketed by activity_view.

The credits.used field reflects the authenticated user’s own billing-period consumption; all other aggregate fields (characters, lines, runs, daily buckets, activity buckets) are workspace-scoped across all members.

Date boundaries are computed in the supplied timezone (IANA, e.g. America/New_York) so “today” and “this week” align with the caller’s local calendar. Defaults to UTC.

Use GET /usage/by-language for a language-level breakdown, or GET /usage/activity for the event-by-event feed.

Dual-auth: Bearer JWT or API key (scope workspace:read).

Return aggregated usage totals and activity chart data for the workspace. Combines credit consumption, character and line counts, and workflow run statistics for the requested rolling window (`range`) with a chart-ready activity series (`activity`) bucketed by `activity_view`. The `credits.used` field reflects the authenticated user's own billing-period consumption; all other aggregate fields (characters, lines, runs, daily buckets, activity buckets) are workspace-scoped across all members. Date boundaries are computed in the supplied `timezone` (IANA, e.g. `America/New_York`) so "today" and "this week" align with the caller's local calendar. Defaults to UTC. Use `GET /usage/by-language` for a language-level breakdown, or `GET /usage/activity` for the event-by-event feed. Dual-auth: Bearer JWT or API key (scope `workspace:read`).

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

Return aggregated usage totals and activity chart data for the workspace.

Date boundaries are computed in the supplied timezone (IANA, e.g. America/New_York) so “today” and “this week” align with the caller’s local calendar. Defaults to UTC.

Use GET /usage/by-language for a language-level breakdown, or GET /usage/activity for the event-by-event feed.

Dual-auth: Bearer JWT or API key (scope workspace:read).

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