Interface ContentSearchRequestParameters

interface ContentSearchRequestParameters {
    _br_uid_2: string;
    account_id: number;
    auth_key?: string;
    callback?: string;
    catalog_name: string;
    domain_key: string;
    efq?: string | string[];
    facet.precision?: "standard" | "high";
    facet.range?: string;
    facet.version: "3.0";
    fl: string;
    fq?: string | string[];
    group_limit?: number;
    group_offset?: number;
    groupby?: string;
    ll?: string;
    q: string;
    query.numeric_precision?: "standard" | "high";
    query.precision?: "text_match_precision" | "product_type_precision" | "category_precision" | "llm_based_precision";
    query.relaxation?: "product_type" | "off";
    query.smartsort?: "off" | "top_products";
    query.spellcorrect?: "off" | "term_frequency" | "closest_match";
    ref_url?: string;
    request_id?: number;
    request_type: "search";
    rows: number;
    search_type: "keyword" | "category" | "bestseller";
    sort?: string;
    start: number;
    stats.field?: string;
    url: string;
    user_id?: string;
    view_id?: string;
}

Hierarchy (view full)

Properties

_br_uid_2 account_id auth_key? callback? catalog_name domain_key efq? facet.precision? facet.range? facet.version fl fq? group_limit? group_offset? groupby? ll? q query.numeric_precision? query.precision? query.relaxation? query.smartsort? query.spellcorrect? ref_url? request_id? request_type rows search_type sort? start stats.field? 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

Optional callback

callback?: string

Indicates whether data wrapped in the function for CORS requests

catalog_name

catalog_name: string

Named identifier of the catalog. A catalog is a grouping of items into a broader category such as blogs, videos, etc. A catalog is a representation of a group of items and must have a unique name, that is also unique to a domain (if you have multiple sites).

Catalogs are created in the DataConnect UI by default, you can rename the catalogs when you set up your catalogs initially.

domain_key

domain_key: string

Product/Content catalog name

Optional efq

efq?: string | string[]

Extends the filtered query and applies a complex boolean filter to search results to include or exclude items that fit your parameter values. Any product attribute in your product feed is valid, such as brand names and sizes.

Optional facet.precision

facet.precision?: "standard" | "high"

Facet Precision cleans up the facet noise coming from the irrelevant products further down in the recall set without impacting the actual product recall itself. It helps remove irrelevant facets.

Optional facet.range

facet.range?: string

Return a count of ranged facets, such as price and sale price. Use numeric attributes only. You need to parse the values that are in the facets_counts section of the response.

facet.version

facet.version: "3.0"

Facet version, this SDK only supports version 3.0

fl

fl: string

Filtered list of attributes you want returned in your API response (i.e. productID, price). Multiple values should be comma separated All fl parameters for Product Search or Category requests must include pid as one of their value

Optional fq

fq?: string | string[]

The fq parameter applies a faceted filter to the returned products, searching for products that fit your parameter values. Use fq=store_lat_lon to enable filtering by distance for BOPIS.

Optional group_limit

group_limit?: number

Number of items in a group when grouping parameter exists.

Optional group_offset

group_offset?: number

This allows you to set the pagination within groups. The default value of group_offset is 0

Optional groupby

groupby?: string

The attribute that products will be grouped by. Grouping Attribute specifications:

  • It must be an indexed, single-valued text attribute.
  • It cannot be a numeric attribute.
  • It cannot be a SKU attribute.
  • You can only use 1 attribute on the groupby field.
  • Reserved attributes such as pid, brand, etc. cannot be used for grouping.

Optional ll

ll?: string

The latitude-longitude of the end-customer used for the Buy Online Pick-up In Store (BOPIS) feature. Value should be provided as latitude,longitude. For example, ll=11.09,10.018.

q

q: string

Partial search query

Optional query.numeric_precision

query.numeric_precision?: "standard" | "high"

Numeric Precision makes the recall set more precise by limiting the recall to only those products that match the numeric intent expressed in the query.

Optional query.precision

query.precision?: "text_match_precision" | "product_type_precision" | "category_precision" | "llm_based_precision"

Search Recall Precision targets and removes the recall noise to only show relevant products for a query.

Optional query.relaxation

query.relaxation?: "product_type" | "off"

Query Relaxation aims at reducing zero results by identifying the core product type in a query if an exact match isn’t found.

Optional query.smartsort

query.smartsort?: "off" | "top_products"

SmartSort ensures that when your shopper chooses to sort the product results, then:

  • Any noise in the recall set remains buried.
  • Only relevant products surface when the shopper applies a sort.

Optional query.spellcorrect

query.spellcorrect?: "off" | "term_frequency" | "closest_match"

Spell Correct aims at reducing zero results by autocorrecting misspelled queries.

Optional ref_url

ref_url?: string

URL of the page or HTTP referrer where request started

Optional request_id

request_id?: number

ID to track site visitor clicks

request_type

request_type: "search"

The type of API request. Value should be search for Product & Category Search.

Default

search

rows

rows: number

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

search_type

search_type: "keyword" | "category" | "bestseller"

The type of search. Value should be "keyword" for Product Search requests, category for "Category" requests.

Default

keyword

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.

Optional stats.field

stats.field?: string

This parameter allows you to display the maximum and minimum values of any numeric field in your data set for a user query. With this parameter, you can get all the documents matching a query and display the minimum and maximum values of single-valued, numeric attributes such as price, sale_price, length, width, reviews, etc.

url

url: string

Absolute URL of the page where the request initiated

Optional user_id

user_id?: string

The universal customer ID of the user. You only need to pass this field if your particular integration tracks customers this way. The parameter captures user IDs from the customer side, and reuses the information when powering apps or enhancing cross-device linking. In this way, Bloomreach recognizes users in a way that's aligned with your system. Use an anonymous string. Don't use email or other personally identifiable information. If you do not track users this way, then omit this field.

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.

Settings

Member Visibility

Theme

On This Page

_br_uid_2account_idauth_keycallbackcatalog_namedomain_keyefqfacet.precisionfacet.rangefacet.versionflfqgroup_limitgroup_offsetgroupbyllqquery.numeric_precisionquery.precisionquery.relaxationquery.smartsortquery.spellcorrectref_urlrequest_idrequest_typerowssearch_typesortstartstats.fieldurluser_idview_id