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

Path parameters

idstring 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_namestring required

Name of the index to get stats for

Query parameters

delimiterstring

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

Request body

{"stackTrail":"components:schemas:DescribeTableIndexStatsRequest:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

idstring[]

versioninteger nullable

Optional table version to get stats for

branchstring

Branch to target. When not specified, the main branch is used.

index_namestring

Name of the index

Example request

{
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "version": 0,
  "branch": "branch",
  "index_name": "index_name"
}

Response

Index statistics

{"stackTrail":"components:schemas:DescribeTableIndexStatsResponse:properties:context","oasType":"schema","type":"unknown","description":"Arbitrary context as key-value pairs.\nHow to use the context is custom to the specific implementation.\n\nOn a request, it carries caller-provided context to the implementation.\nOn a response, it carries implementation-provided context back to the caller.\n\nREST NAMESPACE ONLY\nContext entries are mapped to and from HTTP headers using the `header.` prefix:\n- On a request, any entry whose key starts with `header.` is sent as an HTTP\n request header with the prefix stripped. For example, the entry\n `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header\n `Authorization: Bearer abc`.\n- On a response, every HTTP response header is returned as an entry whose key is the\n header name prefixed with `header.`. For example, the response header\n `x-request-id: abc123` is returned as the entry `{\"header.x-request-id\": \"abc123\"}`.\n"}

distance_typestring nullable

Distance type for vector indexes

index_typestring nullable

Type of the index

num_indexed_rowsinteger nullable

Number of indexed rows

num_unindexed_rowsinteger nullable

Number of unindexed rows

num_indicesinteger nullable

Number of indices

Example response

{
  "num_indices": 0,
  "distance_type": "distance_type",
  "num_unindexed_rows": 0,
  "context": {
    "key": "context"
  },
  "num_indexed_rows": 0,
  "index_type": "index_type"
}

Changes

Changed in 11 of the 55 revisions of this API.204057

Jul 1, 2026591cd95574b07See the full diff
- ○
  added the optional property context to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property context to the response with the 5XX status
  response-optional-property-added
Jun 5, 20269932582b6bd71See the full diff
- ○
  added the new optional request property branch
  new-optional-request-property
Jan 2, 202683f8516f05071See the full diff
- ○
  added the new optional request property context
  new-optional-request-property
Jan 1, 2026c987c26ccb0f1See the full diff
- ○
  added the new optional request property identity
  new-optional-request-property
Dec 20, 20255d6099d672d3666See the full diff
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 400
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 401
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 403
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 404
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 503
  response-property-min-decreased
- ▲
  the code response property's min was decreased from 400.00 to 0.00 for the response status 5XX
  response-property-min-decreased
- ●
  removed the optional property type from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property type from the response with the 5XX status
  response-optional-property-removed
- ○
  the response property code became required for the status 400
  response-property-became-required
- ○
  the response property code became required for the status 401
  response-property-became-required
- ○
  the response property code became required for the status 403
  response-property-became-required
- ○
  the response property code became required for the status 404
  response-property-became-required
- ○
  the response property code became required for the status 503
  response-property-became-required
- ○
  the response property code became required for the status 5XX
  response-property-became-required
Dec 11, 20256ad4337e38491See the full diff
- ○
  added the optional property num_indices to the response with the 200 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 202540a3bc489d4661212See the full diff
- ▲
  the response property type became optional for the status 400
  response-property-became-optional
- ▲
  the response property type became optional for the status 401
  response-property-became-optional
- ▲
  the response property type became optional for the status 403
  response-property-became-optional
- ▲
  the response property type became optional for the status 404
  response-property-became-optional
- ▲
  the response property type became optional for the status 503
  response-property-became-optional
- ▲
  the response property type became optional for the status 5XX
  response-property-became-optional
- ●
  removed the optional property status from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property status from the response with the 5XX status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 503 status
  response-optional-property-removed
- ●
  removed the optional property title from the response with the 5XX status
  response-optional-property-removed
- ○
  added the optional property code to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property code to the response with the 5XX status
  response-optional-property-added
- ○
  added the optional property error to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 503 status
  response-optional-property-added
- ○
  added the optional property error to the response with the 5XX status
  response-optional-property-added
Jul 25, 20258769f8e36bc422See the full diff
- ●
  removed the request property name
  request-property-removed
- ●
  removed the request property namespace
  request-property-removed
- ○
  added the new optional request property id
  new-optional-request-property
- ○
  added the new optional request property index_name
  new-optional-request-property
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2025ac7519693c523See the full diff
- ○
  api tag Index added
  api-tag-added
- ○
  added the new optional query request parameter delimiter to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter delimiter
  new-optional-request-parameter
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 21, 2025db7569410aa42See the full diff
- ○
  api operation id GetIndexStats removed and replaced with DescribeTableIndexStats
  api-operation-id-removed
- ○
  api tag Metadata added
  api-tag-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history (11 revisions)