Get Search Analytics
Popular and zero-result doc site searches, with a daily series and changes against the previous window.
Returns what visitors searched for on the doc site — the most popular queries and the ones that found nothing — with a daily series and changes against the previous window of the same length.
Session JWT and org membership required. Any role can read it — an API key gets 401, a non-member 403. Any plan.
Path Parameters
projectIdQuery Parameters
days30Response Fields
data.popularquery, count, and avgResults — the average number of results, sent as a decimal string.data.zeroResultquery, count. These are your clearest content gaps.data.daily{ date, total, zeroResults }, oldest first. Days with no searches are left out.data.changessearches and zeroResults (percent) and clickThrough (points) against the previous window. A key is left out when there is nothing to compare with.data.clickThroughpopular row also gets clickThrough and topResult (the most clicked result path, or null).Click-through is usually absent today. clickThrough, changes.clickThrough and the per-query clickThrough and topResult are sent only when the window has at least one recorded result click, and deployed doc sites do not report clicks yet — only searches you track yourself with clickedResult on the search beacon count. Without clicks the fields are left out rather than reported as 0.
daily, changes and the click-through fields are optional — see trend fields. If the search query itself fails, the response is 200 with empty popular and zeroResult lists.
Error Responses
401 Unauthorized
Missing, invalid or expired session JWT, or an API key.
403 Forbidden
You are not a member of the organization that owns the project.
404 Not Found
The project does not exist or has been deleted.