Skip to main content
GET
/
v1
/
knowledge-base
/
audit
/
retrievals
Query governed KB retrieval-audit logs (incl. misses/blocks/errors)
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/knowledge-base/audit/retrievals \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "ref": "",
      "retrieval_status": "<string>",
      "serving_decision": "<string>",
      "audit_write_status": "<string>",
      "requested_kb_count": 123,
      "result_count": 123,
      "response_ref_count": 123,
      "eligible_version_count": 123,
      "duration_ms": 123,
      "actor_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rag_query_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "query_hash": "<string>",
      "query_hash_key_version": "<string>",
      "query_length_bucket": "<string>",
      "request_id": "<string>",
      "trace_id": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
start
string<date-time>
required

Inclusive window start (required).

​
end
string<date-time>
required

Exclusive window end (required).

​
kb_ids
string<uuid>[] | null
​
statuses
string[] | null
​
actor_user_id
string<uuid> | null
​
session_id
string<uuid> | null
​
limit
integer
default:50
Required range: 1 <= x <= 200
​
cursor
string | null

Response

Successful Response

​
items
RetrievalAuditLogSummary · object[]
required
​
has_more
boolean
required
​
next_cursor
string | null