embed v1

Api Get Search Facets

post/v1/instant_search/facets

Request

  • Base URL: https://api.branchly.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.branchly.io/v1/instant_search/facets
  • Auth: none declared

Headers

x-api-keystring nullable

Request body

session_idstring required
navigator_idstring required
localestring required
field_key'page_metadata.article.tags' | 'custom_metadata.tags' required

The field key to get facets for. Should exclude 'metadata' prefix, e.g. 'page_metadata.article.tags'.

Response

Successful Response

total_itemsinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.