Skip to content

crate.searchEvents.refined(body)

refined(body: RefinedBeaconInput, opts: RequestOptions & { beaconToken: string }): Promise<void>

Report a refined search — which facets changed (from → to) — so crate learns how people narrow results.

EndpointPOST /api/v2/search-events/refined
Authbeacon
Returnsvoid
Retryableno
Idempotentno
await crate.searchEvents.refined(
{ search_event_id: id, changed_facets: [{ name: 'genre', to: 'idm' }] },
{ beaconToken },
);
  • beacon_token_required — when beaconToken is missing.