What a managed user's editor sessions spent

Says how many credits the editor sessions of one of your managed users took from your account over a period, in total and for each operation. A generation costs one credit, taken from your account when it starts; one that fails is refunded and is counted as refunded, not as spent.

Only what was spent through editor sessions is here, and only since usage was first recorded: what you spend with your API key, and anything from before, is not. Use it to see which of your users spend the most, or to charge them for it. To hold one session to a number of credits, set max_credits when you make it (createManagedUserEditorSession).

The period runs from startDate (included) to endDate (not included): the 30 days before now when you give neither, and at most 366 days. A date without a time is midnight UTC at the start of that day, so for all of October give startDate=2026-10-01 and endDate=2026-11-01.

GET /managed-users/{id}/usage

TypeScript SDK

TypeScript

import { Configuration, ManagedUsersApi } from '@widgetic/api-sdk-ts';

const managedUsersApi = new ManagedUsersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// What this user's editor sessions spent in October:
const { data: usage } = await managedUsersApi.getManagedUserUsage({
  id: managedUserId,
  startDate: '2026-10-01',
  endDate: '2026-11-01'
});

console.log(usage.totals.credits, usage.operations);

200

{
  "success": true,
  "data": {
    "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "managedUserExternalId": "Example managedUserExternalId",
    "from": "2026-01-15T09:30:00.000Z",
    "to": "2026-01-15T09:30:00.000Z",
    "totals": {},
    "operations": [
      "Example ManagedUserOperationUsage"
    ]
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

The managed user whose usage you want (Widgetic's id for the user)

Query Parameters

startDate · string

Start of the period, included: an ISO 8601 date (2026-10-01) or date-time with its offset (2026-10-01T08:00:00Z). Default: 30 days before endDate.

endDate · string

End of the period, not included, in the same forms. Default: now. It must be after startDate, by at most 366 days.

Response

200

application/json

What the managed user's editor sessions spent in the period

success · boolean · required

Always true on a success.

Example:

true

data · object · required

What a managed user's editor sessions spent over a period. Only credits taken through editor sessions are counted, from the day usage was first recorded: what you spend with your API key is not, and neither is anything from before.

Show child attributes

Example:

{
  "managedUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "managedUserExternalId": "Example managedUserExternalId",
  "from": "2026-01-15T09:30:00.000Z",
  "to": "2026-01-15T09:30:00.000Z",
  "totals": {},
  "operations": ["Example ManagedUserOperationUsage"]
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes