Skip to main content
GET
/
v1
/
analytics
/
knowledge
/
documents
/
top-retrieved
Top-N most-retrieved documents in a window
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/knowledge/documents/top-retrieved \
  --header 'x-api-key: <api-key>'
[
  {
    "document_id": "<string>",
    "kb_id": "<string>",
    "hit_count": 123,
    "sum_score": 123,
    "avg_score": 123,
    "max_score": 123,
    "best_rank": 123
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
kb_id
string | null
​
limit
integer
default:20
Required range: 1 <= x <= 200
​
start_date
string<date>
required
​
end_date
string<date>
required

Response

Successful Response

​
document_id
string
required
​
kb_id
string
required
​
hit_count
integer
required
​
sum_score
number
required
​
avg_score
number
required
​
max_score
number
required
​
best_rank
integer
required