List text indexes

Lists every full-text indexed field in the tenant with its document count and average document length.

GET /v1/tenants/{tenant}/fts

See which fields have text indexesCounts describe indexed content; this request does not retrieve documents.

List the tenant's indexesRequest the full-text index inventory.
Find the table fieldIdentify each searchable field.
Inspect its document statisticsCompare count and average document length.

Before you start

Use your database bearer token.

Path parameters

Field	Type	Required
`tenant`	`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

Each entry identifies an indexed table field, its document count and average document length. Use these values to inspect indexing, not to retrieve the indexed documents themselves.

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.
429	Honor Retry-After when present; back off.
502	Check service availability and the write outcome.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/fts" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "complete": true,
  "fields": [
    {
      "table": "demo_docs",
      "field": "body",
      "num_docs": 1,
      "avg_doc_length": 5
    }
  ]
}

Illustrates the single indexed p1 fixture; counts change when p2 is indexed.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses