Initiatives and campaign calendar tools

list_initiatives

Lists every initiative defined in a project. Initiatives are organizational containers (use-case folders) that group related campaigns and analyses. The response gives you the name, description, color, pinned flag, archived flag, and tags.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.

Response parameters

The tool returns an InitiativesResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[InitiativeSummary]The initiative summaries.
errorstr | nullError message if the request failed.

The InitiativeSummary object has the following fields:

FieldTypeDescription
idstrThe initiative's unique ID.
namestrThe initiative's display name.
descriptionstr | nullThe initiative's description.
colorstr | nullThe display color of the initiative card.
pinnedboolWhether the initiative is pinned to the top of the list.
archivedboolWhether the initiative has been archived.
tagslist[str]User-defined tags.
createdany | nullUnix timestamp of when the initiative was created.
created_by_display_namestr | nullDisplay name of the creator.
editedany | nullUnix timestamp of the last edit.
edited_by_display_namestr | nullDisplay name of the last editor.

get_initiative

Returns the full definition of a single initiative, including its description, color, and use-case template metadata (difficulty, goal, recommended channels, and required modules).

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
initiative_idstrYesThe initiative ID returned by list_initiatives.

Response parameters

The tool returns an InitiativeResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
dataInitiative | nullThe full initiative definition.
errorstr | nullError message if the request failed.

The Initiative object adds the following field on top of the summary record:

FieldTypeDescription
use_case_metadataany | nullThe use-case template metadata: difficulty, goal, recommended channels, and required modules.

get_initiative_items

Lists every item assigned to an initiative. Items include campaigns (email, SMS, scenarios, banners, and so on) and analyses (funnels, trends, reports). Each item carries its type, ID, name, and status.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
initiative_idstrYesThe initiative ID returned by list_initiatives.

Response parameters

The tool returns an InitiativeItemsResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
datalist[any]The items inside this initiative. Each item carries a type, ID, name, and status.
errorstr | nullError message if the request failed.

get_campaign_calendar

Returns the campaign calendar for a project: scheduled one-time email and SMS campaign entries within a date window. Each entry includes the campaign name, type, status, and scheduled send time.

The date window is set with Unix timestamps (in seconds). If you omit from_ts and to_ts, the window defaults to the current week.

Request parameters

NameTypeRequired?Description
project_idstrYesThe project ID returned by list_projects.
from_tsint | nullNoStart of the window as a Unix timestamp in seconds. Defaults to the start of the current week.
to_tsint | nullNoEnd of the window as a Unix timestamp in seconds. Defaults to the end of the current week.

Response parameters

The tool returns a CampaignCalendarResponse object with the following parameters:

ParameterTypeDescription
successboolWhether the request succeeded.
campaignslist[any]Scheduled campaign entries in the requested window. Each entry includes campaign name, type, status, and send time.
errorstr | nullError message if the request failed.


© Bloomreach, Inc. All rights reserved.