Skip to main content
GET
/
v1
/
settings
/
metadata-indexes
List Metadata Indexes
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/settings/metadata-indexes \
  --header 'Authorization: Bearer <token>'
[
  {
    "indexName": "metadata.tier_1",
    "entityName": "transaction",
    "metadataKey": "tier",
    "unique": false,
    "sparse": true,
    "stats": {
      "accesses": 150,
      "statsSince": "2024-01-15T10:30:00Z"
    }
  },
  {
    "indexName": "metadata.externalId_1",
    "entityName": "account",
    "metadataKey": "externalId",
    "unique": true,
    "sparse": false,
    "stats": {
      "accesses": 1200,
      "statsSince": "2024-01-10T08:00:00Z"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string

The authorization token. This header is required if your environment has Access Manager enabled.

​
Content-Type
string

The type of media of the resource. Recommended value is application/json.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Query Parameters

​
entity_name
string

The name of the entity to filter the metadata indexes.

Response

Indicates that the request was successful and the response contains the expected data.

​
indexName
string
required

The name of the index in the database.

Example:

"metadata.tier_1"

​
entityName
string
required

The name of the entity associated with the index.

Example:

"transaction"

​
metadataKey
string
required

The metadata key used in the index.

Example:

"tier"

​
unique
boolean
required

Indicates whether the index enforces uniqueness.

Example:

false

​
sparse
boolean
required

Indicates whether the index is sparse (ignores documents without the indexed field).

Example:

true

​
stats
object
required

Index usage statistics.