SPB Git

Repository Public

users.md 35.4 KB 871 lines markdown

1---2title: Users3url: https://platform.claude.com/docs/en/api/beta/organization/analytics/users4---56# Users78## List User Activity910**GET** `/v1/organizations/analytics/users`1112Get per-user activity for a given day, with cursor-based pagination.1314Returns activity metrics for each user in the organization, sorted by email15address. Use `group_by[]` for per-RBAC-group aggregates, or `filter[]` to16scope results to specific members, groups, or a chat project. Available17to organizations on a Claude Enterprise plan. Requires an API key with18the `read:analytics` scope.1920### Query parameters2122- `date: optional string`2324  UTC date in YYYY-MM-DD format. The day to get user activity for. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.2526  format: date2728- `ending_date: optional string`2930  UTC date in YYYY-MM-DD format. End of the date range (exclusive); only valid with `starting_date`. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day), so this can be at most today — which is also the default when omitted, resolved once when the first page is served and reused for the rest of the pagination sequence. At most 366 days after `starting_date`.3132  format: date3334- `filter: optional array of string`3536  Filters as `dimension:value`, e.g. `filter[]=rbac_group_id:{id}`. Repeat the param for OR within a dimension and across dimensions for AND. Supported dimensions on this endpoint: `project_id`, `rbac_group_id`, `user_id`. Value forms: `project_id` takes a tagged project id (`claude_proj_...`) and scopes each member's row to their claude.ai chat activity within that project (it cannot be combined with `group_by[]` or an `rbac_group_id` filter); `rbac_group_id` takes the tagged id (`rbac_group_...`, as emitted in responses and by the spend-limits API) or a bare group UUID, and matches users who held the group at any point during each covered UTC day (time-of-usage attribution); `user_id` takes a tagged user id (`user_...`), as emitted in responses. An unsupported dimension returns 400. At most 100 entries.3738  maxItems: 1003940- `group_by: optional array of "rbac_group_id"`4142  Dimensions to break results out by (e.g. `group_by[]=rbac_group_id`). Supported on this endpoint: `rbac_group_id`. Rows are already per-member, so the one supported grouping aggregates them per RBAC group instead. Grouped rows carry the requested dimension values as additional fields and paginate like ungrouped responses via `next_page`; an unsupported dimension returns 400. `rbac_group_id` attributes a user to every group they held at any point during each covered UTC day, so grouped rows are not an exclusive partition and can sum above org-level totals. At most 100 entries.4344  maxItems: 1004546- `limit: optional number`4748  Number of results per page (1-1000, default 100).4950  minimum: 1, maximum: 10005152- `order: optional "asc" or "desc"`5354  Sort direction: `asc` or `desc`. Defaults to `asc` for the endpoint's sort column and to `desc` when `order_by` names a metric (a top-N ranking). Applies to `order_by`, or to the endpoint's default sort field when `order_by` is omitted.5556  - `"asc"`5758  - `"desc"`5960- `order_by: optional string`6162  Sort field. Restricted to the endpoint's sort column plus its rankable metrics (metrics default to descending; a few metrics rank in date-range mode only, per the endpoint's documented orderable set).6364- `page: optional string`6566  Opaque cursor from a previous response's `next_page` field.6768- `starting_date: optional string`6970  UTC date in YYYY-MM-DD format. Start of a date range (inclusive). Enables rollup mode: one row per entity aggregated over the whole range — addable counters are summed across days, and a distinct count is never summed where summing could double-count (a field's range value is recomputed exactly over the window, approximate via HLL with typical error under 2%, null, or — for the creation-event counts, whose per-day values cannot overlap — a per-day sum that is itself exact; each field's own description says which). Use either `date` or `starting_date`, not both. Data is typically available with a 1-day lag (varies by query; the error for a too-recent date names the latest available day) and may be revised by a few percent over the following days. No earlier than 2026-01-01.7172  format: date7374### Returns7576- `BetaUserActivity object`7778  Response for GET /v1/organizations/analytics/users.7980  - `data: array of object`8182    - `chat_metrics: object`8384      Claude.ai activity metrics for a single user on a given day.8586      - `connectors_used_count: number`8788        Number of MCP connector invocations.8990      - `distinct_artifacts_created_count: number`9192        Number of distinct artifacts created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.9394      - `distinct_connectors_used_count: number or null`9596        Distinct claude.ai connectors this user used. Excludes calls whose connector could not be identified and all calls from organizations with zero data retention. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.9798      - `distinct_conversation_count: number or null`99100        Number of distinct conversations the user participated in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.101102      - `distinct_files_uploaded_count: number or null`103104        Number of distinct files uploaded. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.105106      - `distinct_projects_created_count: number`107108        Number of distinct projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.109110      - `distinct_projects_used_count: number or null`111112        Number of distinct projects used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.113114      - `distinct_shared_artifacts_viewed_count: number or null`115116        Number of distinct shared artifacts the user viewed. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.117118      - `distinct_skills_used_count: number or null`119120        Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.121122      - `message_count: number`123124        Number of messages sent125126      - `shared_conversations_viewed_count: number`127128        Number of times the user opened a shared conversation in a project129130      - `thinking_message_count: number`131132        Number of messages that used extended thinking133134    - `claude_code_metrics: object`135136      Claude Code activity metrics for a single user on a given day.137138      - `core_metrics: object`139140        Core Claude Code activity metrics for a single user on a given day.141142        - `artifacts_created_count: number`143144          Number of artifacts created in Claude Code sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.145146        - `commit_count: number`147148          Number of commits made via Claude Code149150        - `distinct_session_count: number or null`151152          Number of distinct Claude Code sessions. On aggregated rows and in date-range mode: summed per-day distinct counts. A session essentially never spans a UTC day, so the sum is in practice the true distinct count.153154        - `lines_of_code: object`155156          Lines of code added and removed via Claude Code.157158          - `added_count: number`159160            Lines of code added161162          - `removed_count: number`163164            Lines of code removed165166        - `pull_request_count: number`167168          Number of pull requests created via Claude Code169170      - `tool_actions: object`171172        Per-tool accepted/rejected counts for Claude Code file modification tools.173174        - `edit_tool: BetaToolActionCounts`175176          Accepted/rejected counts for a single Claude Code tool type.177178          - `accepted_count: number`179180            Number of tool proposals accepted181182          - `rejected_count: number`183184            Number of tool proposals rejected185186        - `multi_edit_tool: BetaToolActionCounts`187188          Accepted/rejected counts for a single Claude Code tool type.189190        - `notebook_edit_tool: BetaToolActionCounts`191192          Accepted/rejected counts for a single Claude Code tool type.193194        - `write_tool: BetaToolActionCounts`195196          Accepted/rejected counts for a single Claude Code tool type.197198    - `cowork_metrics: object`199200      Cowork activity metrics for a single user on a given day.201202      - `action_count: number`203204        Number of tool actions completed in Cowork sessions205206      - `artifacts_created_count: number`207208        Number of artifacts created in Cowork sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.209210      - `connectors_used_count: number`211212        Total number of connector invocations in Cowork sessions213214      - `dispatch_turn_count: number`215216        Number of Dispatch (background agent) turns completed217218      - `distinct_connectors_used_count: number or null`219220        Number of distinct connectors used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.221222      - `distinct_session_count: number or null`223224        Number of distinct Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.225226      - `distinct_skills_used_count: number or null`227228        Number of distinct skills used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.229230      - `message_count: number`231232        Number of messages sent in Cowork sessions233234      - `skills_used_count: number`235236        Total number of skill invocations in Cowork sessions237238      - `distinct_plugins_used_count: optional number or null`239240        Number of distinct plugins used in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.241242      - `edit_tool_count: optional number or null`243244        Number of successful Edit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.245246      - `file_edit_count: optional number or null`247248        Number of successful file-edit tool calls (Edit, MultiEdit, Write, NotebookEdit) in Cowork sessions. Null, never 0, while the file-edit metrics are not enabled for this organization.249250      - `multi_edit_tool_count: optional number or null`251252        Number of successful MultiEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.253254      - `notebook_edit_tool_count: optional number or null`255256        Number of successful NotebookEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.257258      - `plugins_used_count: optional number or null`259260        Total number of plugin invocations in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization.261262      - `sessions_with_file_edits_count: optional number or null`263264        Number of distinct Cowork sessions with at least one successful file-edit tool call. Null while the file-edit metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.265266      - `write_tool_count: optional number or null`267268        Number of successful Write tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.269270    - `design_metrics: object`271272      Claude Design activity metrics for a single user on a given day.273274      - `distinct_projects_created_count: number`275276        Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.277278      - `distinct_projects_used_count: number or null`279280        Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.281282      - `distinct_session_count: number or null`283284        Number of distinct Claude Design sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.285286      - `message_count: number`287288        Number of messages sent in Claude Design sessions289290    - `office_metrics: object`291292      Office Agent activity metrics for a single user on a given day, broken out by Office product.293294      - `excel: BetaOfficeProductMetrics`295296        Office Agent activity metrics for a single user on a given day within one Office product.297298        - `connectors_used_count: number`299300          Number of MCP connector invocations301302        - `distinct_connectors_used_count: number or null`303304          Number of distinct MCP connectors used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.305306        - `distinct_session_count: number or null`307308          Number of distinct Office Agent sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.309310        - `distinct_skills_used_count: number or null`311312          Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.313314        - `message_count: number`315316          Number of messages sent317318        - `skills_used_count: number`319320          Number of skill invocations321322      - `outlook: BetaOfficeProductMetrics`323324        Office Agent activity metrics for a single user on a given day within one Office product.325326      - `powerpoint: BetaOfficeProductMetrics`327328        Office Agent activity metrics for a single user on a given day within one Office product.329330      - `word: BetaOfficeProductMetrics`331332        Office Agent activity metrics for a single user on a given day within one Office product.333334    - `science_metrics: object`335336      Claude Science activity metrics for a single user on a given day.337338      - `delegation_count: number`339340        Number of delegations (handoffs to a specialized agent) in Claude Science sessions341342      - `distinct_session_count: number or null`343344        Number of distinct Claude Science sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.345346      - `message_count: number`347348        Number of messages sent in Claude Science sessions349350      - `remote_compute_job_count: number`351352        Number of remote compute jobs launched from Claude Science sessions353354      - `skills_used_count: number`355356        Total number of skill invocations in Claude Science sessions357358    - `web_search_count: number`359360      Number of web searches performed361362    - `distinct_user_count: optional number or null`363364      Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values.365366    - `last_activity_date: optional string or null`367368      Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization.369370      format: date371372    - `rbac_group_id: optional string or null`373374      Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.375376    - `rbac_group_name: optional string or null`377378      Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.379380    - `user: optional BetaAnalyticsUser or null`381382      A user in the organization, identified by tagged id and email address.383384      - `type: "user"`385386        Object type. Always `user`.387388        default: user389390      - `id: string`391392        Tagged user identifier (e.g. `user_...`)393394      - `email_address: string`395396        Email address of the user397398  - `next_page: string or null`399400    Opaque cursor for the next page, or null if no more results401402### Example403404```bash405curl https://api.anthropic.com/v1/organizations/analytics/users \406    -H 'anthropic-version: 2023-06-01' \407    -H "X-Api-Key: $ANTHROPIC_API_KEY"408```409410#### Response (200)411412```json413{414  "data": [415    {416      "chat_metrics": {417        "connectors_used_count": 0,418        "distinct_artifacts_created_count": 0,419        "distinct_connectors_used_count": 0,420        "distinct_conversation_count": 0,421        "distinct_files_uploaded_count": 0,422        "distinct_projects_created_count": 0,423        "distinct_projects_used_count": 0,424        "distinct_shared_artifacts_viewed_count": 0,425        "distinct_skills_used_count": 0,426        "message_count": 0,427        "shared_conversations_viewed_count": 0,428        "thinking_message_count": 0429      },430      "claude_code_metrics": {431        "core_metrics": {432          "artifacts_created_count": 0,433          "commit_count": 0,434          "distinct_session_count": 0,435          "lines_of_code": {436            "added_count": 0,437            "removed_count": 0438          },439          "pull_request_count": 0440        },441        "tool_actions": {442          "edit_tool": {443            "accepted_count": 0,444            "rejected_count": 0445          },446          "multi_edit_tool": {447            "accepted_count": 0,448            "rejected_count": 0449          },450          "notebook_edit_tool": {451            "accepted_count": 0,452            "rejected_count": 0453          },454          "write_tool": {455            "accepted_count": 0,456            "rejected_count": 0457          }458        }459      },460      "cowork_metrics": {461        "action_count": 0,462        "artifacts_created_count": 0,463        "connectors_used_count": 0,464        "dispatch_turn_count": 0,465        "distinct_connectors_used_count": 0,466        "distinct_session_count": 0,467        "distinct_skills_used_count": 0,468        "message_count": 0,469        "skills_used_count": 0,470        "distinct_plugins_used_count": 0,471        "edit_tool_count": 0,472        "file_edit_count": 0,473        "multi_edit_tool_count": 0,474        "notebook_edit_tool_count": 0,475        "plugins_used_count": 0,476        "sessions_with_file_edits_count": 0,477        "write_tool_count": 0478      },479      "design_metrics": {480        "distinct_projects_created_count": 0,481        "distinct_projects_used_count": 0,482        "distinct_session_count": 0,483        "message_count": 0484      },485      "office_metrics": {486        "excel": {487          "connectors_used_count": 0,488          "distinct_connectors_used_count": 0,489          "distinct_session_count": 0,490          "distinct_skills_used_count": 0,491          "message_count": 0,492          "skills_used_count": 0493        },494        "outlook": {495          "connectors_used_count": 0,496          "distinct_connectors_used_count": 0,497          "distinct_session_count": 0,498          "distinct_skills_used_count": 0,499          "message_count": 0,500          "skills_used_count": 0501        },502        "powerpoint": {503          "connectors_used_count": 0,504          "distinct_connectors_used_count": 0,505          "distinct_session_count": 0,506          "distinct_skills_used_count": 0,507          "message_count": 0,508          "skills_used_count": 0509        },510        "word": {511          "connectors_used_count": 0,512          "distinct_connectors_used_count": 0,513          "distinct_session_count": 0,514          "distinct_skills_used_count": 0,515          "message_count": 0,516          "skills_used_count": 0517        }518      },519      "science_metrics": {520        "delegation_count": 0,521        "distinct_session_count": 0,522        "message_count": 0,523        "remote_compute_job_count": 0,524        "skills_used_count": 0525      },526      "web_search_count": 0,527      "distinct_user_count": 0,528      "last_activity_date": "2019-12-27",529      "rbac_group_id": "rbac_group_id",530      "rbac_group_name": "rbac_group_name",531      "user": {532        "id": "id",533        "email_address": "email_address",534        "type": "user"535      }536    }537  ],538  "next_page": "next_page"539}540```541542## Domain types543544### Beta User Activity545546- `BetaUserActivity object`547548  Response for GET /v1/organizations/analytics/users.549550  - `data: array of object`551552    - `chat_metrics: object`553554      Claude.ai activity metrics for a single user on a given day.555556      - `connectors_used_count: number`557558        Number of MCP connector invocations.559560      - `distinct_artifacts_created_count: number`561562        Number of distinct artifacts created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.563564      - `distinct_connectors_used_count: number or null`565566        Distinct claude.ai connectors this user used. Excludes calls whose connector could not be identified and all calls from organizations with zero data retention. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.567568      - `distinct_conversation_count: number or null`569570        Number of distinct conversations the user participated in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.571572      - `distinct_files_uploaded_count: number or null`573574        Number of distinct files uploaded. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.575576      - `distinct_projects_created_count: number`577578        Number of distinct projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.579580      - `distinct_projects_used_count: number or null`581582        Number of distinct projects used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.583584      - `distinct_shared_artifacts_viewed_count: number or null`585586        Number of distinct shared artifacts the user viewed. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.587588      - `distinct_skills_used_count: number or null`589590        Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.591592      - `message_count: number`593594        Number of messages sent595596      - `shared_conversations_viewed_count: number`597598        Number of times the user opened a shared conversation in a project599600      - `thinking_message_count: number`601602        Number of messages that used extended thinking603604    - `claude_code_metrics: object`605606      Claude Code activity metrics for a single user on a given day.607608      - `core_metrics: object`609610        Core Claude Code activity metrics for a single user on a given day.611612        - `artifacts_created_count: number`613614          Number of artifacts created in Claude Code sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.615616        - `commit_count: number`617618          Number of commits made via Claude Code619620        - `distinct_session_count: number or null`621622          Number of distinct Claude Code sessions. On aggregated rows and in date-range mode: summed per-day distinct counts. A session essentially never spans a UTC day, so the sum is in practice the true distinct count.623624        - `lines_of_code: object`625626          Lines of code added and removed via Claude Code.627628          - `added_count: number`629630            Lines of code added631632          - `removed_count: number`633634            Lines of code removed635636        - `pull_request_count: number`637638          Number of pull requests created via Claude Code639640      - `tool_actions: object`641642        Per-tool accepted/rejected counts for Claude Code file modification tools.643644        - `edit_tool: BetaToolActionCounts`645646          Accepted/rejected counts for a single Claude Code tool type.647648          - `accepted_count: number`649650            Number of tool proposals accepted651652          - `rejected_count: number`653654            Number of tool proposals rejected655656        - `multi_edit_tool: BetaToolActionCounts`657658          Accepted/rejected counts for a single Claude Code tool type.659660        - `notebook_edit_tool: BetaToolActionCounts`661662          Accepted/rejected counts for a single Claude Code tool type.663664        - `write_tool: BetaToolActionCounts`665666          Accepted/rejected counts for a single Claude Code tool type.667668    - `cowork_metrics: object`669670      Cowork activity metrics for a single user on a given day.671672      - `action_count: number`673674        Number of tool actions completed in Cowork sessions675676      - `artifacts_created_count: number`677678        Number of artifacts created in Cowork sessions: an artifact counts once, on the day a session first saves it. Counted from 2026-08-17; 0 on earlier days. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.679680      - `connectors_used_count: number`681682        Total number of connector invocations in Cowork sessions683684      - `dispatch_turn_count: number`685686        Number of Dispatch (background agent) turns completed687688      - `distinct_connectors_used_count: number or null`689690        Number of distinct connectors used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.691692      - `distinct_session_count: number or null`693694        Number of distinct Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.695696      - `distinct_skills_used_count: number or null`697698        Number of distinct skills used in Cowork sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.699700      - `message_count: number`701702        Number of messages sent in Cowork sessions703704      - `skills_used_count: number`705706        Total number of skill invocations in Cowork sessions707708      - `distinct_plugins_used_count: optional number or null`709710        Number of distinct plugins used in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.711712      - `edit_tool_count: optional number or null`713714        Number of successful Edit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.715716      - `file_edit_count: optional number or null`717718        Number of successful file-edit tool calls (Edit, MultiEdit, Write, NotebookEdit) in Cowork sessions. Null, never 0, while the file-edit metrics are not enabled for this organization.719720      - `multi_edit_tool_count: optional number or null`721722        Number of successful MultiEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.723724      - `notebook_edit_tool_count: optional number or null`725726        Number of successful NotebookEdit tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.727728      - `plugins_used_count: optional number or null`729730        Total number of plugin invocations in Cowork sessions. Null while Cowork plugin-use metrics are not enabled for this organization.731732      - `sessions_with_file_edits_count: optional number or null`733734        Number of distinct Cowork sessions with at least one successful file-edit tool call. Null while the file-edit metrics are not enabled for this organization. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.735736      - `write_tool_count: optional number or null`737738        Number of successful Write tool calls in Cowork sessions. Null while the file-edit metrics are not enabled for this organization.739740    - `design_metrics: object`741742      Claude Design activity metrics for a single user on a given day.743744      - `distinct_projects_created_count: number`745746        Number of distinct Claude Design projects created. Exact in date-range mode: a creation belongs to exactly one day, so the per-day counts never overlap and their sum over the window is the exact count of distinct creations in it.747748      - `distinct_projects_used_count: number or null`749750        Number of distinct Claude Design projects the user worked in. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.751752      - `distinct_session_count: number or null`753754        Number of distinct Claude Design sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.755756      - `message_count: number`757758        Number of messages sent in Claude Design sessions759760    - `office_metrics: object`761762      Office Agent activity metrics for a single user on a given day, broken out by Office product.763764      - `excel: BetaOfficeProductMetrics`765766        Office Agent activity metrics for a single user on a given day within one Office product.767768        - `connectors_used_count: number`769770          Number of MCP connector invocations771772        - `distinct_connectors_used_count: number or null`773774          Number of distinct MCP connectors used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.775776        - `distinct_session_count: number or null`777778          Number of distinct Office Agent sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.779780        - `distinct_skills_used_count: number or null`781782          Number of distinct skills used. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.783784        - `message_count: number`785786          Number of messages sent787788        - `skills_used_count: number`789790          Number of skill invocations791792      - `outlook: BetaOfficeProductMetrics`793794        Office Agent activity metrics for a single user on a given day within one Office product.795796      - `powerpoint: BetaOfficeProductMetrics`797798        Office Agent activity metrics for a single user on a given day within one Office product.799800      - `word: BetaOfficeProductMetrics`801802        Office Agent activity metrics for a single user on a given day within one Office product.803804    - `science_metrics: object`805806      Claude Science activity metrics for a single user on a given day.807808      - `delegation_count: number`809810        Number of delegations (handoffs to a specialized agent) in Claude Science sessions811812      - `distinct_session_count: number or null`813814        Number of distinct Claude Science sessions. Approximate (HLL, typical error <2%) in date-range mode. Null on aggregated rows where a distinct count cannot be computed.815816      - `message_count: number`817818        Number of messages sent in Claude Science sessions819820      - `remote_compute_job_count: number`821822        Number of remote compute jobs launched from Claude Science sessions823824      - `skills_used_count: number`825826        Total number of skill invocations in Claude Science sessions827828    - `web_search_count: number`829830      Number of web searches performed831832    - `distinct_user_count: optional number or null`833834      Number of distinct active users represented by this row. Only set for grouped rollups (`group_by[]`); null for per-user rows. In date-range mode, recomputed as an exact distinct count of the group's active members over the requested window, never a sum of per-day values.835836    - `last_activity_date: optional string or null`837838      Most recent UTC day (YYYY-MM-DD) on which the user had any counted activity, within the requested window: equal to the requested `date` in single-day mode, and to the latest active day from `starting_date` (inclusive) to `ending_date` (exclusive) in date-range rollup mode — never a day earlier than the window start. On filtered requests (`filter[]`) only days matching the filter count: with `filter[]=rbac_group_id:{id}` it is the last day the user was active while a member of that group, consistent with the row's other metrics. On grouped (`group_by[]`) rows it is the latest day any member of the group was active (the requested `date` in single-day mode). Omitted from the response while last-activity reporting is not enabled for this organization.839840      format: date841842    - `rbac_group_id: optional string or null`843844      Tagged RBAC group identifier (`rbac_group_...`), matching the spend-limits API spelling. Present only when the request grouped by `rbac_group_id`.845846    - `rbac_group_name: optional string or null`847848      Resolved RBAC group display name, alongside `rbac_group_id` when name resolution is available. Null if the group has been deleted or its name could not be resolved; `rbac_group_id` remains the stable key.849850    - `user: optional BetaAnalyticsUser or null`851852      A user in the organization, identified by tagged id and email address.853854      - `type: "user"`855856        Object type. Always `user`.857858        default: user859860      - `id: string`861862        Tagged user identifier (e.g. `user_...`)863864      - `email_address: string`865866        Email address of the user867868  - `next_page: string or null`869870    Opaque cursor for the next page, or null if no more results871
Files main
Menu

Theme