Search Terms

Taylor Sloane Updated by Taylor Sloane

GET /v1/stats/search

Retrieve stats about how many searches have been made in a given timeframe. We stem searches at HelpDocs, so search_term in the response is a stemmed term that we used to run the search internally. Original search terms (i.e. the ones actually typed by your users) are available as original_search_terms

This route accepts all stats filters as query parameters.

Example response:

{
"search_terms": [
{
"average_results": 7, // on average this search returned this many results
"count": 10,
"original_search_terms": [
"search terms here",
"search and TERMs here"
],
"search_term": "search term here"
},
...
]
}

How did we do?

Filtering Stats

Top Articles

Contact

This site is protected by hCaptcha and its Privacy Policy and Terms of Service apply.