Web and mobile campaigns tools

list_banners: List the weblayer banner campaigns in a project.
get_banner: Get the full definition of a weblayer banner.
list_in_app_messages: List the in-app message campaigns in a project.
get_in_app_message: Get the full definition of an in-app message.
list_experiments: List the web personalization A/B experiments in a project.
get_experiment: Get the full definition of a web personalization experiment.
list_surveys: List the survey campaigns in a project.
get_survey: Get the full definition of a survey.

list_banners

Lists every weblayer banner campaign in a project. Banners are pop-ups, slide-ins, and embedded overlays displayed on websites through the Bloomreach JavaScript SDK. The response gives you the name, status, tags, archived flag, and initiative assignment. The variant content and targeting are not included here — use get_banner for those.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a BannersResponse object with the following parameters:

Parameter	Type	Description
`success`	`bool`	Whether the request succeeded.
`data`	`list[BannerSummary]`	The weblayer banner summaries.
`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.

get_banner

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

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.
`banner_id`	`str`	Yes	The banner ID returned by `list_banners`.

Response parameters

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.

list_in_app_messages

Lists every in-app message campaign in a project. In-app messages are overlay campaigns shown inside mobile apps through the Bloomreach Mobile SDK. The response gives you the name, status, tags, archived flag, and initiative assignment. The message content and triggers are not included here — use get_in_app_message for those.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns an InAppMessagesResponse object with 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.

get_in_app_message

Returns 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`	Yes	The in-app message ID returned by `list_in_app_messages`.

Response parameters

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.

list_experiments

Lists every web personalization A/B experiment in a project. Experiments run controlled tests of different web content variants to measure conversion impact. The response gives you the name, status, tags, archived flag, and initiative assignment. Variant definitions and goal configuration are not included here — use get_experiment for those.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns an ExperimentsResponse object with 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.

get_experiment

Returns the full definition of a single web personalization 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`	Yes	The experiment ID returned by `list_experiments`.

Response parameters

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.

list_surveys

Lists every survey campaign in a project. Surveys collect structured input from customers — NPS, ratings, open-text, multi-choice. The response gives you the name, status, tags, archived flag, and initiative assignment. Questions and triggers are not included here — use get_survey for those.

Request parameters

Name	Type	Required?	Description
`project_id`	`str`	Yes	The project ID returned by `list_projects`.

Response parameters

The tool returns a SurveysResponse object with 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.

get_survey

Returns the full definition of a single survey campaign, 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`	Yes	The survey ID returned by `list_surveys`.

Response parameters

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.