Skip to main content
GET
/
v1
/
analytics
/
knowledge
/
documents
/
retrieval-timeseries
Search-call volume and latency percentiles bucketed over time
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/analytics/knowledge/documents/retrieval-timeseries \
  --header 'x-api-key: <api-key>'
[
  {
    "time_bucket": "2023-11-07T05:31:56Z",
    "total": 123,
    "hits": 123,
    "misses": 123,
    "reranked": 123,
    "errors": 123,
    "hit_rate_pct": 123,
    "avg_results": 123,
    "avg_duration_ms": 123,
    "p50_ms": 123,
    "p90_ms": 123,
    "p95_ms": 123,
    "p99_ms": 123
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
granularity
string
default:hour
Pattern: ^(minute|hour|day|week)$
​
caller
string | null
Pattern: ^(api|aop_tool|aop_action_node)$
​
start_date
string<date>
required
​
end_date
string<date>
required

Response

Successful Response

​
time_bucket
string<date-time>
required
​
total
integer
required
​
hits
integer
required
​
misses
integer
required
​
reranked
integer
required
​
errors
integer
required
​
hit_rate_pct
number
required
​
avg_results
number
required
​
avg_duration_ms
number
required
​
p50_ms
number
required
​
p90_ms
number
required
​
p95_ms
number
required
​
p99_ms
number
required