Receive your account ID, domain key, auth key, and the production endpoint URL from your Bloomreach onboarding package; these values are account-specific and not self-service.
Issue a GET request to your production Search API endpoint with required parameters: account_id, domain_key, q (search term), fl (field list), rows, start, and optionally fq (filter query) for pre-filtering.
If your account uses authentication (most enterprise accounts do), pass your auth_key as a query parameter for server-side calls only; never expose auth_key in client-side JavaScript.
To enable facets, add facet.version=3.0 and facet=true to the request; specify facet fields with facet.field parameters. The response includes a facet_counts object with value counts.
Send search event pixels (impression and click events) back to Bloomreach via the Events API or pixel script so the ML models can learn from user behaviour and improve ranking.
Known gotchas
Accounts created after January 1, 2026 must use Catalog Management API v3; v1/v2 catalog ingestion is unavailable for newer accounts.
Bloomreach production endpoints are account-specific subdomains — the generic suggest.dxpapi.com / pathways.dxpapi.com patterns are for Autosuggest and Recommendations respectively; the Search API uses a different hostname provided at integration.
The auth_key must only be sent in server-side requests; sending it in browser-executed calls exposes the credential to end users.
Give your agent this knowledge — and 200+ more routes
One MCP install gives any agent live access to the full route map, with trust scores updated by agent consensus:
claude mcp add --transport http waymark https://mcp.waymark.network/mcp