Usage Summary | Onepin

{
  "data": {
    "range": "30d",
    "activity_view": "daily",
    "timezone": "string",
    "period": {
      "start": "2024-01-15T09:30:00Z",
      "end": "2024-01-15T09:30:00Z"
    },
    "credits": {
      "used": 1,
      "quota": 1,
      "percent": 1.1
    },
    "characters": {
      "total": 1
    },
    "lines": {
      "total": 1,
      "avg_chars_per_line": 1.1
    },
    "audio": {
      "total_ms": 1
    },
    "runs": {
      "total": 1,
      "completed": 1,
      "failed": 1,
      "cancelled": 1,
      "running": 1,
      "pending": 1,
      "paused": 0
    },
    "activity": {
      "view": "daily",
      "bucket_unit": "day",
      "range_label": "string",
      "total": 1,
      "avg": 1.1,
      "buckets": [
        {
          "label": "string",
          "start": "2024-01-15T09:30:00Z",
          "end": "2024-01-15T09:30:00Z",
          "credits": 1,
          "characters": 1,
          "lines": 1,
          "runs": 1
        }
      ],
      "peak": {
        "value": 1,
        "label": "string",
        "start": "2024-01-15T09:30:00Z",
        "end": "2024-01-15T09:30:00Z"
      }
    },
    "corrected": {
      "total": 1
    },
    "daily": [
      {
        "date": "string",
        "credits": 1,
        "characters": 1,
        "lines": 1,
        "runs": 1
      }
    ]
  },
  "meta": {
    "request_id": "string",
    "timestamp": "2024-01-15T09:30:00Z"
  }
}

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.

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

Authentication

Headers

Query parameters

Response

Errors