Upstash Documentation

Get Index Stats

Retrieves statistics and metrics for a specific search index
1 min read
get/search/{id}/stats
Request example
Response
get/search/{id}/stats

Authorization

Authorizationstringheaderrequired#
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded username:password.

Path parameters

idstringrequired#
The ID of the search index

Query parameters

periodenum<string>#

Time period for statistics aggregation. Each period returns 60 datapoints
with intervals adjusted to the period length.

Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.

Default: "1h"

Options:1h3h12h1d3d7d30d

Responses

application/json
200
Statistics for the specified search index retrieved successfully
pending_index_countinteger#
Number of pending index operations
current_vector_countinteger#
Current number of vectors in the index
daily_query_countinteger#
Total number of query operations executed today
daily_update_countinteger#
Total number of update operations executed today
monthly_query_countinteger#
Total query operations in current month
monthly_update_countinteger#
Total update operations in current month
monthly_bandwidth_usageinteger#
Total bandwidth used in current month (bytes)
storage_usageinteger#
Current storage used (bytes)
monthly_costnumber#
Total cost in current month
daily_update_requestsobject[]#
Daily update requests over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
daily_query_requestsobject[]#
Daily query requests over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
daily_bandwidthsobject[]#
Daily bandwidth usage over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
daysstring[]#
Days of the week for measurement
query_throughputobject[]#
Query throughput over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
update_throughputobject[]#
Update throughput over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
query_latency_meanobject[]#
Average query latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
query_latency_99object[]#
99th percentile query latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
update_latency_meanobject[]#
Average update latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
update_latency_99object[]#
99th percentile update latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
embeds_latency_meanobject[]#
Average embedding latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
embeds_latency_99object[]#
99th percentile embedding latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
vector_countobject[]#
Vector count over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
data_sizeobject[]#
Data size over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
daily_rerank_countinteger#
Total number of rerank operations executed today
monthly_rerank_countinteger#
Total rerank operations in current month
daily_rerank_requestsobject[]#
Daily rerank requests over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
rerank_latency_meanobject[]#
Average rerank latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value
rerank_latency_99object[]#
99th percentile rerank latency over time
Show child attributes
xstringrequired#
Timestamp when measurement was taken
ynumberrequired#
The measured value