Parameters for the Widget API

get

https://bsapi-test.brsrvr.com/v3/fetch_widget

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Tip
You can escape non-alphanumeric characters in your parameter values, using URL percent-encoding conventions.

Endpoints

Production: Please reach out to your Account Manager or Technical Consultant for your endpoint
Staging: https://bsapi-test.brsrvr.com

Query Params

url

string

required

The URL for the webpage that is sending the request.

acct_auth

string

required

The Bloomreach-provided authentication key for your account ID.

acct_id

string

required

The Bloomreach-provided ID for your account.

ptype

string

enum

required

The page type.

Allowed:

ref

string

required

The URL of the HTTP referrer for the webpage where the request is made. If the value is not available, then leave this parameter empty.

user_agent

string

required

The browser user agent, which lets Bloomreach track web crawling. Take this parameter value directly from the HTTP headers supplied by your customer's browser request.

prod_id

string

The unique identifier for the product in your product catalog or database. This parameter affects product pages only. Not needed for category requests.

prod_name

string

The name of the product in your product catalog or database. Not needed for category requests.

pstatus

string

enum

The status of a product on the page. This parameter affects product pages only.

Allowed:

output_format

string

enum

Defaults to html

The format in which you'd like to receive the response. Use html to return an HTML response, use br_json to return a JSON response.

Allowed:

Language

Loading…

Response

Click Try It! to start a request and see the response here!