Add search queries analytics API endpoint#4926
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
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 documentation for the new search queries analytics API endpoint (
GET /v1/analytics/{projectId}/searches), which lets users export search term data from their documentation including hit counts, click-through rates, and top clicked pages.Changes
analytics.openapi.json)api/analytics/searches.mdxdocs.jsonTriggered by mintlify/server@383de3f which added the search analytics external endpoint.
Note
Low Risk
Documentation-only changes: adds a new Analytics OpenAPI path/schema and wires it into docs navigation/introduction, with no runtime logic impacted.
Overview
Adds API reference documentation for search query analytics export via new
GET /v1/analytics/{projectId}/searches.Updates
analytics.openapi.jsonwith the new/searchesendpoint andSearchesResponseschema (hits, CTR, top clicked page, last searched timestamp, pagination/total). Adds the newapi/analytics/searches.mdxpage and links it fromapi/introduction.mdxand the Analytics group indocs.json.Written by Cursor Bugbot for commit 1d1ad0f. This will update automatically on new commits. Configure here.