Skip to content

Add search queries analytics endpoint#4925

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-search-analytics-endpoint-1774557741
Closed

Add search queries analytics endpoint#4925
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/add-search-analytics-endpoint-1774557741

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Mar 26, 2026

Summary

  • Added the GET /v1/analytics/{projectId}/searches endpoint to the analytics OpenAPI spec and documentation
  • New endpoint returns paginated search term aggregates with hit counts, click-through rates, top clicked pages, and total search event counts
  • Added corresponding MDX page and navigation entry under Analytics

Note

Low Risk
Low risk: this PR only adds OpenAPI schema/docs and navigation for a new analytics export endpoint, with no runtime/business-logic changes shown.

Overview
Adds a new Analytics Export API endpoint, GET /v1/analytics/{projectId}/searches, to return paginated aggregates of documentation search terms (hits, CTR, top clicked page, last searched timestamp) plus totalSearches and nextCursor.

Introduces the SearchesResponse schema in analytics.openapi.json, adds a new api/analytics/searches.mdx reference page, and wires it into the API reference navigation in docs.json under Analytics.

Written by Cursor Bugbot for commit 6051ee2. This will update automatically on new commits. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Mar 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Mar 26, 2026, 8:45 PM

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

"totalSearches",
"nextCursor"
]
},
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SearchesResponse missing hasMore field unlike sibling schemas

Medium Severity

The new SearchesResponse schema omits the hasMore boolean field, while both FeedbackResponse and AssistantConversationsResponse in this same API include hasMore as a required property alongside nextCursor. API consumers building generic pagination logic across the analytics endpoints (all sharing the same auth, parameter patterns, and pagination style) would expect a consistent response contract. The missing field breaks that consistency and could cause client-side pagination code to fail when switching to or integrating the searches endpoint.

Fix in Cursor Fix in Web

@ethanpalm
Copy link
Copy Markdown
Collaborator

Closing as duplicate of #4926, which covers the same search queries analytics endpoint with more complete field descriptions.

@ethanpalm ethanpalm closed this Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant