Help Center

Menu

Search administration API

The search administration API provides a set of API calls for interacting with DXP search administration services.

Accessing the search administration API

Access to the search administration API requires a valid API token or administration login.

In the DXP token-based access must use the username and password that is provided by a v2 token.

The API can be used interactively using the API UI, which can be accessed from the administration dashboard (system) menu.

See: API authentication using an API token

Search administration API calls

All APIs open in full page width to accommodate schema expansion and exploration.
Click Funnelback APIs to return to the full list of APIs offered in Squiz Search.

All search administration API calls should be made relative to the /admin-api path on your search administration server URL. e.g. GET https://searchadmin.example.com/admin-api/analytics/v1/collections/{collection}/queries/top.