Skip to content

Get a stream facet

GET
/content/delivery/v1/streams/{externalId}/facets
curl --request GET \
--url https://api.ebitex.io/content/delivery/v1/streams/example/facets \
--header 'Authorization: Bearer <token>'

The distinct values of one declared filter (field), and how many items match each. Counts respect every other active filter but not the facet’s own, so a facet never narrows itself. Send the same filter.<key>= values you send the stream.

value is what to send back as the filter. Category values also carry path and label, and reference values carry label. Full-text filters have no facet.

Key: a delivery key (content.delivery.read).

externalId
required
string
field
string
locale
string

OK

unknown_filter_field: no field, an undeclared one, or the full-text filter. validation_failed, unknown_category and category_not_in_group as for the stream.

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired.

scope_denied: the key lacks this route’s scope. origin_denied or ip_denied: a browser-safe key was used from an origin or address outside its restrictions. app_not_available: Content is not enabled for the organization.

unknown_stream: no stream has this external id or id.

Quota exceeded; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.