This reference contains some useful information about the parameters for Recommendations and Pathways APIs.
Common values
These parameters are mandatory for all Recommendations and Pathways APIs, and should be passed with the same values across all widget types.
- _br_uid_2
- account_id
- url
- ref_url
- domain_key
- view_id
- request_id
Widget-specific Parameters
This table lists which parameters are specific to which widget types, and whether each parameter is required or optional.
Item Widgets | Category Widgets | Keyword Widgets | Personalization Widgets | Global Widgets | |
---|---|---|---|---|---|
endpoint | Required | Required | Required | Required | Required |
widget_id | Required | Required | Required | Required | Required |
fields | Optional | Optional | Optional | Optional | Optional |
rows | Optional | Optional | Optional | Optional | Optional |
filters | Optional | Optional | Optional | Optional | Optional |
user_id | Optional | Optional | Optional | Required | Optional |
item_ids | Required | N/A | N/A | N/A | N/A |
cat_id | N/A | Required | N/A | N/A | N/A |
facet | N/A | Optional | Optional | N/A | N/A |
query | N/A | N/A | Required | Required | N/A |