Database endpoints
Read vector index counts
Read vector record counts for each namespace and the index as a whole.
GET /v1/tenants/{tenant}/vector-indexes/{index}/stats
- Select the vector indexRequest its count summary.
- Read total and namespace countsCompare stored records at both levels.
- Inspect truncation and pending workKeep pending counters separate from stored-record totals.
Before you start
Use your database bearer token.
Use the target vector index and, where required, its namespace. The examples use index demo-search and namespace demo.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
index | string | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Read the result
Use total_record_count for the index and each namespace's record_count for its part. Check truncated before treating the namespace list as complete; pending counters have a different meaning from stored records.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 200 | OK |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 404 | Check the resource ID and API route. |
| 429 | Honor Retry-After when present; back off. |
| 500 | Check the outcome before retrying a write. |
| 501 | Check deployment support for this operation. |
| 503 | Honor Retry-After when present; check write outcomes. |