SEseekstorm
Index

Get Index Info

Changed on

Get index Info from index with index_id

get/api/v1/index/{index_id}

Request

Path parameters

index_idinteger required

index id

Headers

apikeystring required

YOUR_SECRET_API_KEY

Response

Index found, returns the index info

idinteger required

Index ID

namestring required

Index name

schemaobject required

Schema definition for the index

indexed_doc_countinteger required

Number of indexed documents

committed_doc_countinteger required

Number of committed documents

operations_countinteger required

Number of operations: index, update, delete, queries

query_countinteger required

Number of queries, for quotas and billing

versionstring required

SeekStorm version the index was created with

facets_minmaxobject required

Minimum and maximum values of numeric facet fields

Example response

{
  "name": "demo_index",
  "schema": {
    "title": {
      "field": "title",
      "store": true,
      "index_lexical": true,
      "field_type": "Text",
      "boost": 10,
      "field_id": 0
    },
    "body": {
      "field": "body",
      "store": true,
      "index_lexical": true,
      "field_type": "Text",
      "field_id": 1
    },
    "url": {
      "field": "url",
      "store": true,
      "index_lexical": false,
      "field_type": "Text",
      "field_id": 2
    },
    "date": {
      "field": "date",
      "store": true,
      "index_lexical": false,
      "field_type": "Timestamp",
      "facet": true,
      "field_id": 3
    }
  },
  "version": "0.11.1",
  "facets_minmax": {
    "date": {
      "min": 831306011,
      "max": 1730901447
    }
  }
}

Changes

  • 546064e21d73Revision changes
    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • info

      added the optional property to the response with the status

  • 39cce1ef7d95Revision changes
    • info

      api operation id get_index_info_api removed and replaced with get_index_info