Skip to main content
GET
/
reporting
/
knowledge
/
statistics
Retrieve knowledge base statistics
curl --request GET \
  --url https://api.getfernand.com/reporting/knowledge/statistics \
  --header 'X-API-Key: <api-key>'
{
  "visitors": {
    "2026-01-01": 42,
    "2026-01-02": 38,
    "2026-01-03": 51
  },
  "views": {
    "2026-01-01": 156,
    "2026-01-02": 142,
    "2026-01-03": 189
  },
  "searches": {
    "2026-01-01": 8,
    "2026-01-02": 12,
    "2026-01-03": 6
  },
  "total_searches": 427
}
Returns time-series data for knowledge base usage metrics. Data is aggregated by date based on the specified or automatically determined interval. The response includes total search count for the period.

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

Knowledge base statistics retrieved successfully.

​
visitors
object

Unique visitor counts grouped by date. Each key is a formatted date string based on the interval.

Example:
{
  "2026-01-01": 42,
  "2026-01-02": 38,
  "2026-01-03": 51
}
​
views
object

Total article view counts grouped by date. Each key is a formatted date string based on the interval.

Example:
{
  "2026-01-01": 156,
  "2026-01-02": 142,
  "2026-01-03": 189
}
​
searches
object

Count of searches with no matching results, grouped by date. Each key is a formatted date string based on the interval.

Example:
{
  "2026-01-01": 8,
  "2026-01-02": 12,
  "2026-01-03": 6
}
​
total_searches
integer

Total number of all searches (including those with results) during the entire period.

Example:

427