BloomreachContentSearchGeneratedApiContentSearchApiRequest

Request parameters for contentSearchApi operation in BloomreachContentSearchGeneratedApi.

interface BloomreachContentSearchGeneratedApiContentSearchApiRequest {
	readonly accountId: number;
	readonly authKey?: string;
	readonly brUid2: string;
	readonly callback?: ContentSearchApiCallbackEnum;
	readonly catalogName: string;
	readonly domainKey: string;
	readonly efq?: string;
	readonly facetField?: string;
	readonly facetRange?: string;
	readonly facetVersion?: number;
	readonly fl: string;
	readonly fq?: string;
	readonly q: string;
	readonly refUrl: string;
	readonly requestType: ContentSearchApiRequestTypeEnum;
	readonly rows: number;
	readonly searchType: ContentSearchApiSearchTypeEnum;
	readonly sort?: string;
	readonly start: number;
	readonly url: string;
	readonly userId?: string;
	readonly viewId?: string;
}

Properties

Name	Required	Type	Description
`accountId`	Required	`number`	Your site's numerical Bloomreach account ID. Your Bloomreach representative gives your site's account ID to you before or during your integration kickoff meeting. <br><br> The value shown here, <i>6413</i>, is provided as an example.
`authKey`	Optional	`string`	The Bloomreach-provided authentication key for the Bloomreach account that's sending the request. <br><br> Pass the auth_key with an empty value in client-side calls. The auth_key value is a private authorization key. If you include your valid auth_key value in client-side calls, then you inadvertently expose that private information to everybody.
`brUid2`	Required	`string`	A first-party cookie created by the Bloomreach tracking pixel library (BrTrk). This cookie creates a unique, anonymous identifier for every browser or device. <br><br> Use the default value provided, which is already encoded.
`callback`	Optional	`ContentSearchApiCallbackEnum`	Indicates whether to return data wrapped in the function for cross-origin requests. <br><br> For server-side requests, use the value br_server. For native-app requests, use the value br_app.
`catalogName`	Required	`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). <br><br> Catalogs are created in the DataConnect UI by default, you can rename the catalogs when you set up your catalogs initially.
`domainKey`	Required	`string`	Your site domain's ID, which is provided by Bloomreach. This ID is for the domain that you want to receive your Bloomreach API requests. This parameter identifies the specific site version when the one account ID hosts multiple site versions with unique characteristics, such as language versions. Bloomreach uses your domain_key parameter value to ensure that only the data that pertains to that site version is used for query and analytics features, such as autosuggestions.
`efq`	Optional	`string`	Applies a complex boolean filter to search results to include or exclude items that fit your parameter values. Any attribute in your content feed is valid, such as title and description. <br><br> Typically, the efq parameter is used for custom attributes that you include in your content feed to support additional business logic that you might need to filter. Read more about using the efq parameter in the "Complex boolean filtering" section in the Faceting and filtering page.
`facetField`	Optional	`string`	Returns a list of fields to facet on. You must explicitly request all the facets you would like returned.
`facetRange`	Optional	`string`	Return a count of ranged facets, such as price and sale price. Use numeric attributes only. <br><br> You need to parse the values that are in the facets_counts section of the response. The facet_queries section has custom range facets for numeric fields that you define in your request. The facet_fields section gives you facets that you can display to your site's users, such as brands and colors.
`facetVersion`	Optional	`number`	Set the value of this parameter to "3.0" to use the new Facet Response v3. This will return the facet information in the new unified format.
`fl`	Required	`string`	The attributes that you want returned in your API response, such as item IDs and prices. <br><br> All fl parameters for Content Search must include item_id as one of their values. Any attribute from your content feed may be used as a value for fl. <br><br> Multiple values should be comma separated, such as fl=item_id,price.
`fq`	Optional	`string`	The fq parameter applies a faceted filter to the returned content, searching for content that fits your parameter values. <br><br> Any facet that you want to filter must be in your feed. Read more about using the fq parameter in the "Simple Filtering" section in the Faceting and filtering page. <br><br> You can configure Attributes from the Catalog Management Tab. Configure which attributes in your content feed you want to apply as filters to search results.
`q`	Required	`string`	Your site visitor's search query. Search queries are composed of one or more terms. <br><br> You can percent encode spaces between terms as %20, or you can leave the spaces unencoded. <br><br> If you use q=, the latency of the response will vary depending on your catalog size and it may not adhere to Bloomreach's standard SLA. Additionally, most merchandising operations do not work on query parameters, except for include/exclude operations.
`refUrl`	Required	`string`	The URL of the page or HTTP referrer where the request is started.
`requestType`	Required	`ContentSearchApiRequestTypeEnum`	The type of API request. Value should be search for Content Search requests.
`rows`	Required	`number`	The number of matching items to return per results page in the API response. The maximum value is 100. <br><br> To enhance performance, limit this value to the number of items that you think is reasonable for a single page of search results.
`searchType`	Required	`ContentSearchApiSearchTypeEnum`	The type of search. Value should be keyword for Content Search requests.
`sort`	Optional	`string`	Sorts results based on the field value in ascending, descending, or another combination of orders. You can sort any fl field. <br><br> Value is a field name, followed by asc/desc for ascending/descending order respectively. For example, sort=sale_price desc sorts in descending order of the sale price
`start`	Required	`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. <br><br> The maximum value is 1000.
`url`	Required	`string`	The absolute URL of the page where the request is initiated. Do not use a relative URL.
`userId`	Optional	`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. <br><br> Use an anonymous string. Don't use email or other personally identifiable information. <br><br> If you do not track users this way, then omit this field.
`viewId`	Optional	`string`	A unique identifier for a specific view of your content catalog. If you have multiple versions of your site, each with their own content catalog characteristics like content titles and descriptions, then add view_id to your call. <br><br> Bloomreach uses your view_id parameter value to display the right content 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 content catalog. <br><br> Bloomreach Content Search can support a single view_id, multiple view_ids (separated by commas) or * view_id in a single API parameter for a single content catalog. If no view_ids are passed for a content item in a catalog, Bloomreach will assign a br_default_view value. If an API call is made with no view_id in the request, the br_default_view content items will return. <br><br> If a content item contains more than one view_id in the catalog and those view_ids are passed in the API param, we will return those documents without de-duping or grouping.

BloomreachContentSearchGeneratedApiContentSearchApiRequest

Properties

Referenced Types

On this page