Skip to main content
POST
/
v1
/
table
/
{id}
/
stats
Get table statistics
curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/stats \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ]
}
'
{
  "total_bytes": 1,
  "num_rows": 1,
  "num_indices": 1,
  "fragment_stats": {
    "num_fragments": 1,
    "num_small_fragments": 1,
    "lengths": {
      "min": 1,
      "max": 1,
      "mean": 1,
      "p25": 1,
      "p50": 1,
      "p75": 1,
      "p99": 1
    }
  }
}

Authorizations

​
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.

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
​
identity
object

Identity information of a request.

​
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.

​
id
string[]

Response

Table statistics

​
total_bytes
integer<int64>
required

The total number of bytes in the table

Required range: x >= 0
​
num_rows
integer<int64>
required

The number of rows in the table

Required range: x >= 0
​
num_indices
integer<int64>
required

The number of indices in the table

Required range: x >= 0
​
fragment_stats
object
required

Statistics on table fragments