Get Index Document Count🔗︎

HTTP Verb	Path
GET	/v9/index/(indexId)/count

Retrieve the number of documents in a single index. See Standard Transaction Cost

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
There should never be a need to call this endpoint. You control when documents are added/deleted from your indexes, so you should always know how many documents are in any given index.

Path Parameters🔗︎

Parameter	Data Type	Description
indexId	string	The id of the index (case-insensitive).

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object

Value🔗︎

Contains response data for the transaction.

Value properties

Count 🔗︎ integer

Count🔗︎

The number of documents in the index.

CreditsRemaining 🔗︎ decimal

CreditsRemaining🔗︎

The number of remaining credits is returned with every response. Please ensure that you set up monitoring of this value to ensure that you don't experience an outage by letting your credits reach 0.

Sample JSON

{
  "Info": {
    "Code": "string",
    "Message": "string"
  },
  "Value": {
    "CreditsRemaining": 0,
    "Count": 0
  }
}

Code	Description
`Success`	Successful transaction
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided
`Unauthorized`	Your account doesn't have permission to perform this operation
`DataNotFound`	Data with the specified name wasn't found