Skip to main

API Technical Specs

Learn how to configure and leverage our services to achieve your toughest recruiting needs.
SaaS     |

Get Index Document Count

GET /v9/index/(indexId)/count

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

Notes

  • You can try this endpoint out at our Swagger page ( US Data Center | EU 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

ParameterData TypeDescription
indexIdstringThe id of the index (case-insensitive).

Response Body

Infoobject
Information explaining the outcome of the transaction.
Info.Codestring
A response code elaborating on the HTTP status code.
The following is a list of codes that can be returned by the service:

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
Info.Messagestring
This message further describes the code providing additional detail.
Valueobject
Contains response data for the transaction.
Value.Countinteger
The number of documents in the index.
Value.CreditsRemainingdecimal
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 Response

{ ... 
{ ... 
Code :  "string",Message :  "string",
},
{ ... 
CreditsRemaining :  0,Count :  0,
},
}