AACsearch
Api reference

Add a sorting field

Enables sorting on an existing field in the index schema.

Enables sorting on an existing field in the index schema.

POST
/indexes/{indexId}/sorting

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

Search index ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/indexes/string/sorting" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
Empty
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
{
  "error": "string",
  "message": "string",
  "details": null
}
Empty

List sorting fields

Returns all fields in the index that have sorting enabled.

Replace all sorting fields

Replaces all sorting fields with the specified list. Any existing sorting fields not in the list will have sorting disabled.