Usage Activity

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "timestamp": "2024-04-20T14:22:00Z",
      "action": "workflow_run",
      "kind": "scheduled_run",
      "resource": {
        "type": "workflow",
        "id": "wf_1234567890abcdef",
        "name": "Monthly Report Generation"
      },
      "user": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Alice Johnson"
      },
      "metadata": {
        "duration_seconds": 125,
        "status": "success"
      },
      "ip": "203.0.113.42"
    }
  ],
  "meta": {
    "request_id": "req_7a8b9c0d1e2f3g4h5i6j7k8l",
    "timestamp": "2024-04-20T14:22:01Z"
  },
  "pagination": {
    "limit": 1,
    "next": "cursor_eyJpZCI6IjNmYTg1ZjY0NTcxNzQ1NjJiM2ZjMmM5NjNmNjZhZmE2IiwidGltZXN0YW1wIjoiMjAyNC0wNC0yMFQxNDoyMjowMFoifQ==",
    "prev": null
  }
}

Return the workspace activity feed as a cursor-paginated event list.

Each item represents a discrete workspace event (workflow run, voice generated, template applied, member invited, API key created, settings changed). Events are ordered newest-first within the requested rolling window.

Filtering:

type narrows to a single action kind (e.g. workflow_run).
user_id restricts to events triggered by a specific workspace member; returns 404 if the user is not a member of this workspace.
Both filters can be combined.

Pagination: pass the cursor value from a previous response to retrieve the next page. An absent or null cursor in the response means no further pages exist. Page size is controlled by limit (1–100, default 20).

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

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

Return the workspace activity feed as a cursor-paginated event list. Each item represents a discrete workspace event (workflow run, voice generated, template applied, member invited, API key created, settings changed). Events are ordered newest-first within the requested rolling window. Filtering: - `type` narrows to a single action kind (e.g. `workflow_run`). - `user_id` restricts to events triggered by a specific workspace member; returns 404 if the user is not a member of this workspace. - Both filters can be combined. Pagination: pass the `cursor` value from a previous response to retrieve the next page. An absent or null `cursor` in the response means no further pages exist. Page size is controlled by `limit` (1–100, default 20). 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:

typeenum or nullOptional

Filter by usage activity type.

user_idstring or nullOptionalformat: "uuid"

Filter by actor user id.

limitintegerOptional1-100Defaults to 20

cursorstring or nullOptional

Opaque pagination cursor.

timezonestringOptionalDefaults to UTC

IANA timezone for local day bucketing.

Response

Successful Response

datalist of objects

metaobject

paginationobject

Errors

422

Unprocessable Entity Error