Get table index statistics

Get statistics for a specific index on a table. Returns information about the index type, distance type (for vector indices), and row counts.

POST /v1/table/{id}/index/{index_name}/stats

Error

A valid request URL is required to generate request examples

200

{
  "distance_type": "<string>",
  "index_type": "<string>",
  "num_indexed_rows": 1,
  "num_unindexed_rows": 1,
  "num_indices": 1
}

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · required

string identifier of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, v1/namespace/$/list performs a ListNamespace on the root namespace.

index_name · string · required

Name of the index to get stats for

Query Parameters

delimiter · string

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the $ delimiter must be used.

Body

application/json

Index stats request

identity · object

Identity information of a request.

Show child attributes

context · object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

Show child attributes

id · string[]

version · integer<int64> | null

Optional table version to get stats for

Required range: x >= 0

index_name · string

Name of the index

Response

200

application/json

Index statistics

distance_type · string | null

Distance type for vector indexes

index_type · string | null

Type of the index

num_indexed_rows · integer<int64> | null

Number of indexed rows

Required range: x >= 0

num_unindexed_rows · integer<int64> | null

Number of unindexed rows

Required range: x >= 0

num_indices · integer<int32> | null

Number of indices

Required range: x >= 0