AACsearch
Api reference

Get index statistics

Returns live document count from Typesense, 30-day usage aggregates, ingest queue state, and active API key count for the specified index.

Returns live document count from Typesense, 30-day usage aggregates, ingest queue state, and active API key count for the specified index.

GET
/indexes/{indexId}/stats

Authorization

BearerAuth
AuthorizationBearer <token>

Search API key (ss_search_*) from the dashboard or keys API. Scopes (search, ingest, admin) are stored on the key; each route requires the matching scope.

In: header

Path Parameters

indexId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/indexes/string/stats"
{
  "id": "string",
  "slug": "string",
  "displayName": "string",
  "version": 0,
  "documentCount": 0,
  "usage": {
    "since": "2019-08-24T14:15:22Z",
    "totalSearches": 0,
    "totalIndexed": 0,
    "zeroResultCount": 0,
    "clickCount": 0
  },
  "ingestQueue": {
    "pending": 0,
    "failed": 0
  },
  "apiKeysCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}

Trigger full reindex

Enqueues a full reindex job for the specified index. The job rebuilds the underlying Typesense collection from the database. Returns a jobId that can be polled via the indexing.reindexStatus oRPC procedure. Requires admin scope.

List documents

Returns paginated documents from the index. Pass q=* (default) to browse all documents, or a search query to filter results. Requires search scope.