Skip to main content
GET
/
reporting
/
knowledge
/
searches
Retrieve search statistics from the knowledge base
curl --request GET \
  --url https://api.getfernand.com/reporting/knowledge/searches \
  --header 'X-API-Key: <api-key>'
{
  "most_searched": [
    {
      "term": "password reset",
      "quantity": 847
    }
  ],
  "no_results": [
    {
      "term": "api documentation",
      "quantity": 94
    }
  ]
}
Returns analytics on knowledge base search behavior, including the 10 most frequently searched terms and the 10 most common searches that returned no results. This data helps identify content gaps and popular topics in the knowledge base.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Query Parameters

​
start
string<date>
required

Start date for the statistics range in YYYY-MM-DD format.

​
end
string<date>
required

End date for the statistics range in YYYY-MM-DD format.

Response

Search analytics retrieved successfully.

​
most_searched
object[]

Top 10 most frequently searched terms across all searches.

​
no_results
object[]

Top 10 most common search terms that returned zero results, indicating potential content gaps.