Redirects and API parameters tools

list_redirects: List the query-specific redirect rules.
get_redirect: Get the full configuration of a single redirect rule.
list_api_params: List the API parameter override rules for an account. Contact your Bloomreach representative for more details on API parameter overrides.

list_redirects

Lists query-specific redirect rules as paginated summaries. A redirect rule sends a shopper to a specific URL when they search for a particular query. Redirects apply to site-search queries only. Each summary gives you the name, enabled status, associated queries, and scheduling details.

Use get_redirect for a rule's full configuration, including the destination URL and match type.

Request parameters

Name	Type	Required?	Description
`account_name`	`str \| null`	No	The account name. Auto-selected when you have exactly one account. Use `list_discovery_accounts` to see available accounts.
`site_group_id`	`str \| int \| null`	No	A site group ID (numeric) or site name (string). Defaults to `-1` (account level) when omitted. Use `list_discovery_sites` to discover sites.
`page`	`int`	No	The page number, 0-based. Defaults to `0`.
`limit`	`int`	No	Results per page. Defaults to `10`, maximum `100`.
`sort_by`	`str`	No	Field to sort by: `lastModifiedAt`, `identifier`, or `duration`. Defaults to `lastModifiedAt`.
`sort_order`	`str`	No	Sort direction: `ASC` or `DESC`. Defaults to `DESC`.
`q`	`str \| null`	No	Text search to filter rules.

Response parameters

The tool returns a CustomizationsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[CustomizationSummary]`	The redirect rule summaries.
`error`	`str \| null`	Error message if the request failed.

The CustomizationSummary object has the following fields:

Field	Type	Description
`id`	`int`	The unique customization ID.
`name`	`str \| null`	The rule's display name.
`ruleType`	`str`	The rule type, for example `redirect`.
`isEnabled`	`bool \| null`	Whether the rule is currently enabled.
`syncStatus`	`str \| null`	Sync status: `SUCCESS`, `QUEUED`, `FAILED`, `EXPIRED`, or `FUTURE`.
`durationTag`	`str \| null`	Duration tag: `unscheduled`, `scheduled`, `active`, `expiringSoon`, or `expired`.
`startedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule became active.
`endedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule expires.
`createdAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was created.
`lastModifiedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was last modified.
`lastModifiedBy`	`str \| null`	Email or name of the user who last modified the rule.
`queries`	`list[CustomizationQuery]`	The queries this rule applies to.
`isAbTestLive`	`bool`	Whether an A/B test is currently active for this rule.
`audienceName`	`str \| null`	Name of the audience segment this rule targets.

The CustomizationQuery object has the following fields:

Field	Type	Description
`id`	`int \| null`	The query identifier.
`query`	`str \| null`	The query text, for example `green shoes`.
`type`	`str \| null`	The query type, for example `sitesearch` or `category`.

get_redirect

Fetches the full configuration of a single redirect rule by ID. The response returns the destination URL, the match type (exact terms, phrase match, or do-not-redirect), the associated queries and keywords, the enabled status, audience targeting, and scheduling metadata.

Discover rule IDs with list_redirects, then call this tool to inspect a specific redirect.

Request parameters

Name	Type	Required?	Description
`rule_id`	`int`	Yes	The ID of the redirect rule to fetch. Discover IDs with `list_redirects`.
`account_name`	`str \| null`	No	The account name. Auto-selected when you have exactly one account. Use `list_discovery_accounts` to see available accounts.
`site_group_id`	`str \| int \| null`	No	A site group ID (numeric) or site name (string). Defaults to `-1` (account level) when omitted. Use `list_discovery_sites` to discover sites.

Response parameters

The tool returns a CustomizationDetailResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`any \| null`	The full redirect rule detail as freeform JSON. Includes the destination URL, the match type, the associated queries and keywords, the enabled status, audience targeting, and scheduling metadata.
`error`	`str \| null`	Error message if the request failed.

list_api_params

Lists the API parameter override rules for an account. A parameter override changes the URL parameters sent to the search and category APIs without a change to frontend code. For example, an override can raise the default rows count, add fl (field list) parameters, or force a specific sort order. These rules apply globally across both site-search and category queries.

The tool returns up to 1,000 parameter override rules in a single response.

Request parameters

This tool takes no parameters.

Response parameters

The tool returns a CustomizationsResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[CustomizationSummary]`	The API parameter override summaries.
`error`	`str \| null`	Error message if the request failed.

The CustomizationSummary object has the following fields:

Field	Type	Description
`id`	`int`	The unique customization ID.
`name`	`str \| null`	The rule's display name.
`ruleType`	`str`	The rule type, `params`.
`isEnabled`	`bool \| null`	Whether the rule is currently enabled.
`syncStatus`	`str \| null`	Sync status: `SUCCESS`, `QUEUED`, `FAILED`, `EXPIRED`, or `FUTURE`.
`durationTag`	`str \| null`	Duration tag: `unscheduled`, `scheduled`, `active`, `expiringSoon`, or `expired`.
`startedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule became active.
`endedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule expires.
`createdAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was created.
`lastModifiedAt`	`int \| null`	Unix timestamp in milliseconds of when the rule was last modified.
`lastModifiedBy`	`str \| null`	Email or name of the user who last modified the rule.
`queries`	`list[CustomizationQuery]`	The queries this rule applies to.

The CustomizationQuery object has the following fields:

Field	Type	Description
`id`	`int \| null`	The query identifier.
`query`	`str \| null`	The query text, for example `green shoes`.
`type`	`str \| null`	The query type, for example `sitesearch` or `category`.