Get Activity Summaries
api/admin/analytics/retrieve_summaries
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
api/admin/analytics/retrieve_summaries Changed · +18 / -17 lines
# Get Activity Summaries ## Query parameters ## Returns ## Example ### Response (200) ## Get Activity Summaries ### Query Parameters ### Returns ### Example #### Response
---- -title: Get Activity Summaries -url: https://platform.claude.com/docs/en/api/admin/analytics/retrieve_summaries ---- +# Get Activity Summaries -## Get Activity Summaries +**GET** `/v1/organizations/analytics/summaries` -**get** `/v1/organizations/analytics/summaries` - Get organization-wide activity summaries for a date range. Returns one entry per day in [starting_date, ending_date). Data is
filter[]=rbac_group_id:<id>. Available to organizations on a Claude Enterprise plan. Requires an API key with the `read:analytics` scope. -### Query Parameters +## Query parameters - `starting_date: string` UTC date in YYYY-MM-DD format. Start of the date range (inclusive). 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. + format: date + - `ending_date: optional string` UTC date in YYYY-MM-DD format. End of the date range (exclusive). Data is typically available with a 1-day lag, so this can be at most today — which is also the default when omitted, making the last entry cover the most recent available day. Data may be revised by a few percent over the following days. The range may span at most 366 days. + format: date + - `filter: optional array of string` Filters as 'dimension:value'. Only rbac_group_id is supported (e.g. filter[]=rbac_group_id:<id>); repeat the param to OR across groups. Scopes the whole day series to members of the matching group(s), re-aggregated from member-level activity — org-wide seat/invite fields and the adoption rates derived from them are null on scoped rows. rbac_group_id accepts 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 UTC day (time-of-usage attribution). At most 100 entries. -### Returns + maxItems: 100 -- `ActivitySummary object { summaries }` +## Returns +- `ActivitySummary object` + Response for GET /v1/organizations/analytics/summaries. - - `summaries: array of object { assigned_seat_count, cowork_daily_active_user_count, cowork_monthly_active_user_count, 26 more }` + - `summaries: array of object` - `assigned_seat_count: number or null`
Number of users with Claude Science activity in the 7-day rolling window. Omitted from the response while the per-product breakdown is not enabled for this organization. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/analytics/summaries \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` -#### Response +### Response (200) ```json {