Usage By Language

{
  "data": {
    "range": null,
    "timezone": "America/New_York",
    "period": {
      "start": "2024-04-01T04:00:00Z",
      "end": "2024-04-08T04:00:00Z"
    },
    "activity_view": "daily",
    "languages": [
      {
        "locale_code": "en-us",
        "display_name": "English (US)",
        "share": 0.65,
        "credits": 1300,
        "characters": 650000,
        "lines": 1200,
        "allocation_basis": "characters"
      },
      {
        "locale_code": "es-es",
        "display_name": "Spanish (Spain)",
        "share": 0.25,
        "credits": 500,
        "characters": 250000,
        "lines": 450,
        "allocation_basis": "characters"
      },
      {
        "locale_code": "fr-fr",
        "display_name": "French (France)",
        "share": 0.1,
        "credits": 200,
        "characters": 100000,
        "lines": 180,
        "allocation_basis": "characters"
      }
    ],
    "total_credits": 2000,
    "untagged_credits": 50
  },
  "meta": {
    "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "timestamp": "2024-04-08T04:05:00Z"
  }
}

Return workspace audio generation usage broken down by language.

Each row represents one locale with its share of total credit and character consumption. share is a 0..1 fraction of workspace-wide usage for the period; multiply by 100 for a percentage.

Period selection: supply activity_view to align the language rows with the same period shown on the Usage dashboard chart (daily = last 7 local days, weekly = last 12 Monday-start weeks, monthly = last 12 months). When activity_view is provided, range is ignored and range in the response is null. Omit activity_view to use the rolling range window instead.

Date boundaries are computed in the supplied timezone (IANA). Defaults to UTC.

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

Return workspace audio generation usage broken down by language. Each row represents one locale with its share of total credit and character consumption. `share` is a 0..1 fraction of workspace-wide usage for the period; multiply by 100 for a percentage. Period selection: supply `activity_view` to align the language rows with the same period shown on the Usage dashboard chart (daily = last 7 local days, weekly = last 12 Monday-start weeks, monthly = last 12 months). When `activity_view` is provided, `range` is ignored and `range` in the response is `null`. Omit `activity_view` to use the rolling `range` window instead. Date boundaries are computed in the supplied `timezone` (IANA). Defaults to UTC. 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_viewenum or nullOptional

Optional activity view period to align language rows with the selected Usage tab. When supplied, range is ignored and range in the response is null.

Allowed values:

timezonestringOptionalDefaults to UTC

IANA timezone for local day bucketing.

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error