Artifacts
api/admin/analytics/artifacts
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/artifacts Changed · +17 / -14 lines
### Query parameters #### Response (200) ## Domain types ### Query Parameters #### Response ## Domain Types
---- -title: Artifacts -url: https://platform.claude.com/docs/en/api/admin/analytics/artifacts ---- - # Artifacts ## Get Artifact Activity -**get** `/v1/organizations/analytics/artifacts` +**GET** `/v1/organizations/analytics/artifacts` Get artifact-creation activity for a given day, broken out by MIME type.
can be broken out per member or per RBAC group via group_by[], and scoped via filter[]. Requires an API key with the `read:analytics` scope. -### Query Parameters +### Query parameters - `date: string` UTC date in YYYY-MM-DD format. The day to get artifact 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. + format: date + - `filter: optional array of string` 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: artifact_type, is_shared, rbac_group_id, user_id. Value forms: artifact_type is a canonical artifact MIME type (e.g. text/markdown) or 'other'; is_shared is 'true' or 'false'; 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. + maxItems: 100 + - `group_by: optional array of "rbac_group_id" or "user_id"` Dimensions to break results out by: user_id and/or rbac_group_id. The ungrouped artifact-type cube is finite and returned in full; grouped queries multiply the cube and paginate via next_page. rbac_group_id attributes a user to every group they held at any point during the requested UTC day, so grouped rows are not an exclusive partition. At most 100 entries. + maxItems: 100 + - `"rbac_group_id"` - `"user_id"`
Maximum rows to return (1-1000, default 100). The ungrouped artifact-type cube is finite and returned in full; limit is the page size only when group_by[] multiplies the cube. + minimum: 1, maximum: 1000 + - `page: optional string` Opaque cursor from a previous response's next_page field. Only valid with group_by[] — the ungrouped cube is never paginated.
### Returns -- `ArtifactUsage object { data, next_page }` +- `ArtifactUsage object` Response for GET /v1/organizations/analytics/artifacts.
`rbac_group_id`) multiply the cube and paginate like the other analytics list endpoints. - - `data: array of object { artifact_type, artifacts_created_count, distinct_user_count, 6 more }` + - `data: array of object` - `artifact_type: string`
### Example -```http +```bash curl https://api.anthropic.com/v1/organizations/analytics/artifacts \ -H 'anthropic-version: 2023-06-01' \ -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY" ``` -#### Response +#### Response (200) ```json {
} ``` -## Domain Types +## Domain types ### Artifact Usage -- `ArtifactUsage object { data, next_page }` +- `ArtifactUsage object` Response for GET /v1/organizations/analytics/artifacts.
`rbac_group_id`) multiply the cube and paginate like the other analytics list endpoints. - - `data: array of object { artifact_type, artifacts_created_count, distinct_user_count, 6 more }` + - `data: array of object` - `artifact_type: string`