Skip to content

Add search queries analytics API endpoint#4926

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/search-analytics-api-1774557818
Open

Add search queries analytics API endpoint#4926
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/search-analytics-api-1774557818

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Mar 26, 2026

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

  • Added the searches endpoint to the OpenAPI spec (analytics.openapi.json)
  • Created new API reference page at api/analytics/searches.mdx
  • Added the page to the Analytics navigation group in docs.json
  • Updated the API introduction page to reference the new endpoint

Triggered 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.json with the new /searches endpoint and SearchesResponse schema (hits, CTR, top clicked page, last searched timestamp, pagination/total). Adds the new api/analytics/searches.mdx page and links it from api/introduction.mdx and the Analytics group in docs.json.

Written by Cursor Bugbot for commit 1d1ad0f. 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:47 PM

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.

0 participants