Skip to main content

Endpoint

GET https://api.voyantcloud.com/v1/products/search/facets
Retrieve all available facet attributes and their values for the current workspace query. Counts are computed after deduplication so filters stay accurate.

Authentication

Authorization
string
required
Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

Query parameters

q
string
Optional search query applied before faceting.
locale
string
default:"en"
Locale for search. Options: en, ro
type
string
Filter by product type before computing facets.
status
string
Filter by status before computing facets.
organizationId
string
B2B: Filter by organization visibility before computing facets (UUID format).

Request example

curl "https://api.voyantcloud.com/v1/products/search/facets?locale=en" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

facets
object
required
Facet attributes and their values with counts (all facet attributes returned).
exhaustiveFacetsCount
boolean
required
Whether the facet count is exact (true) or approximate (false)
processingTimeMS
integer
required
Processing time (milliseconds)
tookMs
integer
required
Total request time (milliseconds)
{
  "facets": {
    "type": {
      "tour": 156,
      "cruise": 89,
      "experience": 43
    },
    "status": {
      "active": 210,
      "draft": 12
    }
  },
  "exhaustiveFacetsCount": true,
  "processingTimeMS": 12,
  "tookMs": 45
}

Features

  • Returns all facet attributes for the current query.
  • Facet counts are computed after deduplication for accurate totals.
  • Supports the same filters as product search (q, type, status, organizationId, locale).