Interface RecentlyViewedWidgetRequest

interface RecentlyViewedWidgetRequest {
    _br_uid_2: string;
    account_id: number;
    auth_key?: string;
    domain_key: string;
    facet?: boolean;
    fields?: string;
    filter?: string | string[];
    query: string;
    ref_url: string;
    request_id: number;
    rows: number;
    segment?: string;
    sort?: string;
    start: number;
    url: string;
    user_id?: string;
    view_id: string;
}

Hierarchy (view full)

Properties

_br_uid_2 account_id auth_key? domain_key facet? fields? filter? query ref_url request_id rows segment? sort? start url user_id? view_id

Properties

_br_uid_2

_br_uid_2: string

First Party cookie that provides unique identifier

account_id

account_id: number

Account ID

Optional auth_key

auth_key?: string

Authentication Key

domain_key

domain_key: string

Product/Content catalog name

Optional facet

facet?: boolean

Facets are disabled by default. To enable facets, set facet=true.

Optional fields

fields?: string

A comma-separated list of fields to be sent in the request.

Alternatively, you may configure the fields in the Widget Configurator in the Dashboard instead. This parameter is required if not sent via the Dashboard.

Optional filter

filter?: string | string[]

The filter parameter applies a faceted filter to the returned products, searching for products that fit your parameter values. Any facet that you want to filter must be in your feed.

Attributes must be enabled and mapped by Bloomreach. Let your Bloomreach representative know which attributes in your content feed you want to apply as filters to search results.

You can filter results based on numeric ranges. For example, &filter=(price:["100" TO "*"]). Please note that a negative filter on ranges is not supported.

To provide multiple filters, send multiple filter parameters. For example, &filter=(price:["*" TO "100"])&filter=(color_groups: ("blue"))

query

query: string

Your site visitor's search query. Search queries are composed of one or more terms.

You can percent encode spaces between terms as %20, or you can leave the spaces unencoded.

ref_url

ref_url: string

URL of the page or HTTP referrer where request started

request_id

request_id: number

ID to track site visitor clicks

rows

rows: number

The number of matching items to return per results page in the API response. The maximum value is 200.

Optional segment

segment?: string

Segment identifier. Ranking happens only among items with that segment. Example - view_id:ie

Optional sort

sort?: string

Sorts results based on the field value in ascending, descending, or another combination of orders. You can sort any fl field. Value is a field name, followed by asc/desc for ascending/descending order respectively.

start

start: number

The number of the first item on a page of results. For example, the first item on the first page is 0, making the start value also 0. The maximum value is 10000.

url

url: string

Absolute URL of the page where the request initiated

Optional user_id

user_id?: string

ID of the user for personalized recommendations.

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.

Settings

Member Visibility

Theme

On This Page

_br_uid_2account_idauth_keydomain_keyfacetfieldsfilterqueryref_urlrequest_idrowssegmentsortstarturluser_idview_id