Skip to main content
GET
/
v1
/
knowledge-gaps
/
documents
/
health
Per-document retrieval / citation / implication counts with failure rate
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-gaps/documents/health \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "doc_id": "<string>",
      "retrieved_count": 123,
      "retrieved_session_count": 123,
      "failed_session_count": 123,
      "failure_rate": 123,
      "cited_count": 123,
      "implicated_count": 123,
      "retrieval_gap_count": 123,
      "incomplete_knowledge_count": 123,
      "outdated_knowledge_count": 123,
      "title": "<string>",
      "url": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

agent_id
string<uuid> | null
sort
string
default:failure_rate:desc
Pattern: ^(failure_rate:desc|retrieved_count:desc)$
limit
integer
default:50
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0
start_date
string<date>
required
end_date
string<date>
required

Response

Successful Response

items
DocumentHealthRow · object[]
required