Interface Configuration

interface Configuration {
    account_id: number;
    auth_key?: string;
    debug?: boolean;
    domain_key: string;
    searchEndpoint?: string;
    suggestEndpoint?: string;
    view_id?: string;
    widgetEndpoint?: string;
}

Properties

account_id auth_key? debug? domain_key searchEndpoint? suggestEndpoint? view_id? widgetEndpoint?

Properties

account_id

account_id: number

Account ID

Optional auth_key

auth_key?: string

Authentication Key

Optional debug

debug?: boolean

Enable debug log output

domain_key

domain_key: string

Product/Content catalog name

Optional searchEndpoint

searchEndpoint?: string

The endpoint for Product Search & Category Search APIs

Optional suggestEndpoint

suggestEndpoint?: string

The endpoint for Autosuggest API

Optional view_id

view_id?: string

A unique identifier for a specific view of your product catalog. If you have multiple versions of your site, each with their own product catalog characteristics like product titles and prices, then add view_id to your call. Bloomreach uses your view_id parameter value to display the right product information for your customers based on their individual site views. You can enter any string value to identify the specific site catalog view. This string must be consistent in your pixel, API, and product catalog.

Optional widgetEndpoint

widgetEndpoint?: string

The endpoint for Recommendations & Pathways Widgets API

Settings

Member Visibility

Theme

On This Page

account_idauth_keydebugdomain_keysearchEndpointsuggestEndpointview_idwidgetEndpoint