Add Analytics Query API (BFRS + UPA) reference — WIP - #429
Draft
mallikarjun-dhulange wants to merge 4 commits into
Draft
Add Analytics Query API (BFRS + UPA) reference — WIP#429mallikarjun-dhulange wants to merge 4 commits into
mallikarjun-dhulange wants to merge 4 commits into
Conversation
Add async v5 Analytics Query API spec (Behavior, Funnels, Retention, Session-Source, User Property Analysis) plus submit → poll → fetch flow. - New spec: api/analytics-query/analytics-query.yaml (7 endpoints, Public surface, basicAuth; per-endpoint validation limits from PRD) - New overview: api/analytics-query/analytics-query-overview.mdx - Nav: rename API "Analytics" group to "Analyze"; add "Analytics" subgroup WIP: result payloads for behavior/funnels/retention/user-analysis, the full status enum, and async timing details are pending live staging capture (marked TODO(staging) in the spec). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
An unquoted comma in the doc_url description was parsed as a second YAML flow-mapping key, making ErrorResponse an invalid OpenAPI Schema Object and failing the Mintlify build. Quote the description string. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Add standard basicAuth description (matches analytics.yaml) - Fully model BehaviorQueryRequest with per-param descriptions/examples - Fold validation limits into each param's description; drop Limits block - Add reusable FilterGroup / Segmentation / Timerange schemas - Link nested filter objects to Create Filter Segment (house pattern) Template for the other 4 analyses, pending review. Enums set only where confirmed; granularity/chart_type/count_type/chart_plot_type left as description+example pending staging confirmation. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Replicate the Behavior modeling pattern to the other 4 analyses - Fully described params with examples; limits folded into param descriptions - Enums sourced from PRD: funnel_type, retention_type, report_type, granularity - Reuse FilterGroup / Segmentation / Timerange across all 5 - Drop the Limits blocks from endpoint descriptions Pending live capture: verbatim result payloads, percentage count_type code, chart_plot_type value set. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
1 participant
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.
What
Adds the async Analytics Query API (v5) reference — Behavior, Funnels, Retention, Session-Source (BFRS) and User Property Analysis (UPA) — over the Public surface. Endpoints follow a submit → poll → fetch flow.
Source: MCP Analytics Query API's (Confluence)
Changes
api/analytics-query/analytics-query.yaml— 7 endpoints (5POSTsubmit +GETstatus +GETresults),basicAuth,{dc}server, standard error envelope. Per-endpoint validation limits seeded from the PRD.api/analytics-query/analytics-query-overview.mdx.docs.json) — renamed the APIAnalyticsgroup to Analyze; added an Analytics subgroup (overview + endpoints) alongside the unchanged Dashboards.Scope decisions
basicAuthonly.428 QUOTA_EXCEEDED/ FUP andVALIDATION_FAILEDfor parity with the shippedapi/analytics/analytics.yaml.Pending —
TODO(staging)(awaiting staging credentials)SUCCESSFULresult payloads for behavior, funnels, retention, user-analysis (onlysession_countdocumented).PENDING/SUCCESSFUL/FAILEDand whetherFAILEDreturns a reason./resultsbefore completion.typevalues against live (Confluence samples hadfunnelvsfunnels,session-sourcevssession_sourcemismatches).mint broken-linksto confirm overview endpoint slugs resolve.Draft until the above are captured from staging.
🤖 Generated with Claude Code