Web and mobile campaigns tools

search_banners: List the weblayer banner campaigns in a project, or fetch one by ID.
search_in_app_messages: List the in-app message campaigns in a project, or fetch one by ID.
search_experiments: List the web personalization A/B experiments in a project, or fetch one by ID.
search_surveys: List the survey campaigns in a project, or fetch one by ID.

search_banners

Searches the weblayer banner campaigns in a project, or fetches one by ID. Banners are pop-ups, slide-ins, and embedded overlays displayed on websites through the Bloomreach JavaScript SDK. Omit banner_id to list all banners as summary records: name, status, tags, archived flag, and initiative assignment. The variant content and targeting are excluded from the list.

Pass banner_id to fetch the full definition of a single banner, including all A/B split variants (HTML and CSS content), trigger conditions, and customer filter.

In list mode you can narrow the set with archived, status, serving_status, tags, and only_mine, and page through the results with offset and limit.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`banner_id`	`str \| null`	No	The banner ID. Omit to list all; provide to fetch one.
`archived`	`bool \| null`	No	`False`, the default, returns only live banners, matching the UI default. `True` returns only archived banners. Pass null for both.
`status`	`str \| null`	No	Filter by state: `active` for enabled banners or `inactive` for disabled ones. Applied client-side. Omit to return both.
`serving_status`	`str \| null`	No	Filter by computed serving state: `serving`, `before_schedule`, `after_schedule`, or `inactive`. Applied client-side.
`tags`	`list \| null`	No	Return only banners carrying every tag listed, for example `['promo', 'homepage']`. Applied client-side.
`only_mine`	`bool`	No	Return only banners created by the calling user. Defaults to false.
`offset`	`int`	No	The number of records to skip, for pagination. Defaults to `0`.
`limit`	`int`	No	The maximum number of records to return. Defaults to `200`, with a maximum of `1000`.

Response parameters

The tool returns a BannersResponse when banner_id is omitted, or a BannerResponse when it's provided.

The BannersResponse object has the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[BannerSummary]`	The weblayer banner summaries.
`offset`	`int`	The offset used for this request. Defaults to `0`.
`limit`	`int`	The maximum number of records returned for this request. Defaults to `200`.
`archived_items_exists`	`bool \| null`	Whether the project holds any archived banners. Populated only when `archived` is false, the default.
`error`	`str \| null`	Error message if the request failed.

The BannerSummary object has the following fields:

Field	Type	Description
`id`	`str`	The banner's unique ID.
`name`	`str`	The banner's display name.
`status`	`str`	One of `draft`, `active`, or `inactive`.
`archived`	`bool`	Whether the banner has been archived.
`tags`	`list[str]`	User-defined tags.
`initiative_id`	`str \| null`	The initiative this banner belongs to, if any.
`created`	`any \| null`	Unix timestamp of when the banner was created.
`created_by_display_name`	`str \| null`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str \| null`	Display name of the last editor.

When banner_id is provided, the tool returns a BannerResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`Banner \| null`	The full banner definition.
`error`	`str \| null`	Error message if the request failed.

The Banner object adds the following fields on top of the summary record:

Field	Type	Description
`variants`	`list[any]`	The A/B split variants, each with HTML and CSS content and targeting configuration.
`trigger`	`any \| null`	The conditions that decide when the banner is shown, for example URL matching, an event, or a time delay.
`customer_filter`	`any \| null`	The conditions that decide which customers are eligible to see the banner.

search_in_app_messages

Searches the in-app message campaigns in a project, or fetches one by ID. In-app messages are overlay campaigns shown inside mobile apps through the Bloomreach Mobile SDKs. Omit message_id to list all in-app messages as summary records: name, status, tags, archived flag, and initiative assignment. The message content and triggers are excluded from the list.

Pass message_id to fetch the full definition of a single in-app message, including all A/B split variants, trigger conditions, and customer filter.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`message_id`	`str \| null`	No	The in-app message ID. Omit to list all; provide to fetch one.

Response parameters

The tool returns an InAppMessagesResponse when message_id is omitted, or an InAppMessageResponse when it's provided.

The InAppMessagesResponse object has the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[InAppMessageSummary]`	The in-app message summaries.
`error`	`str \| null`	Error message if the request failed.

The InAppMessageSummary object has the following fields:

Field	Type	Description
`id`	`str`	The in-app message's unique ID.
`name`	`str`	The message's display name.
`status`	`str`	One of `draft`, `active`, or `inactive`.
`archived`	`bool`	Whether the message has been archived.
`tags`	`list[str]`	User-defined tags.
`initiative_id`	`str \| null`	The initiative this message belongs to, if any.
`created`	`any \| null`	Unix timestamp of when the message was created.
`created_by_display_name`	`str`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str`	Display name of the last editor.

When message_id is provided, the tool returns an InAppMessageResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`InAppMessage \| null`	The full in-app message definition.
`error`	`str \| null`	Error message if the request failed.

The InAppMessage object adds the following fields on top of the summary record:

Field	Type	Description
`variants`	`list[any]`	The A/B split variants, each with message content and display configuration.
`trigger`	`any \| null`	The conditions that decide when the message is shown, for example an event or a time delay.
`customer_filter`	`any \| null`	The conditions that decide which customers are eligible to see the message.

search_experiments

Searches the web personalization A/B experiments in a project, or fetches one by ID. Experiments run controlled tests of different web content variants to measure conversion impact. Omit experiment_id to list all experiments as summary records: name, status, tags, archived flag, and initiative assignment. Variant definitions and goal configuration are excluded from the list.

Pass experiment_id to fetch the full definition of a single experiment, including all variants (control plus treatment), traffic allocation, goals, and customer filter.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`experiment_id`	`str \| null`	No	The experiment ID. Omit to list all; provide to fetch one.

Response parameters

The tool returns an ExperimentsResponse when experiment_id is omitted, or an ExperimentResponse when it's provided.

The ExperimentsResponse object has the following parameters:

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

The ExperimentSummary object has the following fields:

Field	Type	Description
`id`	`str`	The experiment's unique ID.
`name`	`str`	The experiment's display name.
`status`	`str`	One of `draft`, `active`, or `inactive`.
`archived`	`bool`	Whether the experiment has been archived.
`tags`	`list[str]`	User-defined tags.
`initiative_id`	`str \| null`	The initiative this experiment belongs to, if any.
`created`	`any \| null`	Unix timestamp of when the experiment was created.
`created_by_display_name`	`str`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str`	Display name of the last editor.

When experiment_id is provided, the tool returns an ExperimentResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`Experiment \| null`	The full experiment definition.
`error`	`str \| null`	Error message if the request failed.

The Experiment object adds the following fields on top of the summary record:

Field	Type	Description
`variants`	`list[any]`	The variant definitions (control plus treatments), each with personalization content and traffic allocation.
`goals`	`list[any]`	The success metrics or goals, for example click rate or purchase conversion.
`customer_filter`	`any \| null`	The conditions that decide which customers are eligible for the experiment.

search_surveys

Searches the survey campaigns in a project, or fetches one by ID. Surveys collect structured input from customers — NPS, ratings, open-text, multi-choice. Omit survey_id to list all surveys as summary records: name, status, tags, archived flag, and initiative assignment. Questions and triggers are excluded from the list.

Pass survey_id to fetch the full definition of a single survey, including all question definitions (type, text, options, branching logic), trigger conditions, and customer filter.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`survey_id`	`str \| null`	No	The survey ID. Omit to list all; provide to fetch one.

Response parameters

The tool returns a SurveysResponse when survey_id is omitted, or a SurveyResponse when it's provided.

The SurveysResponse object has the following parameters:

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

The SurveySummary object has the following fields:

Field	Type	Description
`id`	`str`	The survey's unique ID.
`name`	`str`	The survey's display name.
`status`	`str`	One of `draft`, `active`, or `inactive`.
`archived`	`bool`	Whether the survey has been archived.
`tags`	`list[str]`	User-defined tags.
`initiative_id`	`str \| null`	The initiative this survey belongs to, if any.
`created`	`any \| null`	Unix timestamp of when the survey was created.
`created_by_display_name`	`str`	Display name of the creator.
`edited`	`any \| null`	Unix timestamp of the last edit.
`edited_by_display_name`	`str`	Display name of the last editor.

When survey_id is provided, the tool returns a SurveyResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`Survey \| null`	The full survey definition.
`error`	`str \| null`	Error message if the request failed.

The Survey object adds the following fields on top of the summary record:

Field	Type	Description
`questions`	`list[any]`	The question definitions: text, type, options, and branching logic.
`trigger`	`any \| null`	The conditions that decide when the survey is displayed.
`customer_filter`	`any \| null`	The conditions that decide which customers are eligible for the survey.