Add Enterprise Analytics API documentation#38
Merged
hongyi-chen merged 7 commits intomainfrom May 8, 2026
Merged
Conversation
Documents the three endpoints exposed under /api/v1/enterprises/analytics/ (summary, users, events) for enterprise admins on the Early Access program. Covers prerequisites, the Admin Panel privacy toggle, per-endpoint query parameters and response shapes verified against warp-server, pagination semantics, common use cases, roadmap, and FAQ. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Oz <oz-agent@warp.dev>
Drop the 'may change without notice' claim and clarify that Early Access is available to all enterprise teams. Direct admins to the Privacy toggle to start collecting data. Co-Authored-By: Oz <oz-agent@warp.dev>
yuanben-warp
reviewed
May 8, 2026
yuanben-warp
left a comment
yuanben-warp
left a comment
There was a problem hiding this comment.
Overall LGTM, left some comments for suggestion as well as potential internal concept leak concern
The `Message.message` proto oneof is not part of the public API contract, so the docs shouldn't tell readers the `message_type` set 'mirrors' it. Replace the proto reference with a slightly longer list of common values and a forward-looking note. Soften 'snake_case proto field names' on `tool_type` for the same reason. Co-Authored-By: Oz <oz-agent@warp.dev>
- Clarify in the Early Access callout that the API exposes aggregated metrics only; raw conversation contents require cloud-synced conversations. - Add a Performance bullet to the shared endpoints rules noting that wider windows and finer group_by_period granularity can be slower. - Document that periods with no recorded activity are filled with default empty values in the grouped summary response. - Soften the llm_request_ids/model_ids bullet to drop the internal multi-partition summarization detail. - Split was_edited_by_user out as a sub-bullet under code_changes. Co-Authored-By: Oz <oz-agent@warp.dev>
…casing in Related resources Co-Authored-By: Oz <oz-agent@warp.dev>
hongyi-chen
force-pushed
the
hongyi/enterprise-analytics-api-docs
branch
from
efd3661 to
ee2a148
Compare
Same pattern as the Message.message proto leak resolved earlier: don't expose internal auth-backend details to enterprise readers. Replace 'Firebase UID' / 'firebase-uid-abc' with neutral 'user-uuid-abc' and describe user_id as the unique identifier returned by the API. Co-Authored-By: Oz <oz-agent@warp.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new reference page documenting the Enterprise Analytics API (Early Access) under
enterprise/enterprise-features/analytics-api. The page covers the three endpoints exposed under/api/v1/enterprises/analytics/:GET /summary— team-level rollup with optional time-series groupingGET /users— per-user aggregates split bylocal/cloud, paginatedGET /events— message-level activity events, paginated and filterableVerified against the current
warp-serverdevelopbranch (handlers, request/response types, middleware, and feature-flag config), so query parameters, response shapes, defaults, limits, ordering, gating, and the Admin Panel privacy toggle name all match the implementation.What's in the page
:::notecallout pointing readers to their account team and the Admin Panel privacy toggle (Enterprise Usage Reporting (Early Access)).Sidebar / nav
src/sidebar.ts.Validation
npm run build: 316 pages built; sidebar slug resolves and the new MDX parses cleanly.python3 .agents/skills/style_lint/style_lint.py --all: 0 issues.Test plan
npm run devand confirm the sidebar entry shows under Enterprise > Enterprise features.Conversation: https://staging.warp.dev/conversation/1a693f95-7a90-4388-8eaa-faf381c85f87
Co-Authored-By: Oz oz-agent@warp.dev