Journey and campaign tools

Use Sagepilot MCP to find journeys and campaigns, inspect their configuration, and query attributed revenue, estimated ROAS, and delivery rates for a selected period. All tools on this page require workspace_id. Call get_connection_info first and use the workspace ID it returns. Replace the example workspace and entity UUIDs with your own.

Choose a tool

Task	Tool	Required scope and dataset
Find a campaign or journey ID by name	`search_analytics_entities`	`analytics.query` and the selected analytics dataset.
Report revenue and estimated ROAS for one journey	`get_journey_analytics`	`analytics.query` and `marketing_attribution`.
Report on selected campaigns/journeys or template-category delivery	`query_analytics`	`analytics.query` and the queried dataset.
List journeys or inspect a journey flow	`list_journeys`, `get_journey`	`journeys:read` and `journeys`.
List campaigns or inspect a campaign’s lifetime overview	`list_campaigns`, `get_campaign`	`campaigns:read` and `campaigns`.

Analytics access supports reports and name lookup. Journey/campaign product access is separate. See Authentication for connection permissions.

search_analytics_entities

Find IDs for your analytics filters without fetching journey flows or campaign configuration. The response contains dimension and a members array with value (ID) and label (name), including entities with no activity in the reporting period.

Parameter	Description
`dimension`	`campaign_id` or `journey_id`. Required.
`dataset`	`marketing_attribution` (default) or `outbound_messages`. Use a dataset your connection can access.
`search`	Optional case-insensitive name search. Omit to list names alphabetically.
`limit`	1–50 results. Defaults to 20; no cursor. Narrow the search if needed.

Example arguments for search_analytics_entities:

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "dimension": "journey_id",
  "dataset": "marketing_attribution",
  "search": "Welcome",
  "limit": 20
}

Use a returned value as journey_id or in filters.journey_ids. Campaign results work the same way with campaign_id and filters.campaign_ids. The equivalent REST endpoint is Find entity IDs.

get_journey_analytics

Get attributed revenue and estimated ROAS for one journey over a required reporting period. The tool returns the same dataset, rows, summary, and meta fields as the Analytics API, with attribution_revenue and estimated_roas in each matching row.

Parameter	Description
`journey_id`	Journey UUID. Required.
`start_date`, `end_date`	Reporting-period timestamps. Both required. Use ISO 8601 with an explicit timezone offset.
`timezone`	IANA timezone for grouping. Defaults to `UTC`.
`grain`	`day`, `week`, or `month`. Defaults to `day`.
`attribution_type`	Optional `delivery`, `read`, or `clicked` override. Omit to use workspace settings.
`attribution_window_hours`	Optional attribution lookback override, 1–8760 hours. Omit to use workspace settings.
`limit`	Page size, 1–1000. Defaults to 1000.
`cursor`	`meta.cursor` from the previous response. Repeat the same arguments with this value until it is null.

Example arguments for get_journey_analytics:

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "journey_id": "33333333-3333-4333-8333-333333333333",
  "start_date": "2026-09-01T00:00:00Z",
  "end_date": "2026-09-07T23:59:59.999Z",
  "timezone": "UTC",
  "grain": "day",
  "limit": 100
}

The attribution lookback is separate from the reporting period. meta.applied_filters reports the effective workspace settings or overrides. For currency handling, reporting boundaries, and the estimated ROAS formula, see Journey and campaign analytics.

query_analytics

Use query_analytics with marketing_attribution for date-scoped campaign reports or to compare several journeys and campaigns. Use outbound_messages for delivery rates by template category. Call get_analytics_catalog first to discover supported query shapes. Example arguments for campaign attribution and estimated ROAS:

{
  "workspace_id": "11111111-1111-4111-8111-111111111111",
  "dataset": "marketing_attribution",
  "measures": ["attribution_revenue", "estimated_roas"],
  "dimensions": ["time_bucket", "entity_type", "entity_id"],
  "filters": {
    "campaign_ids": ["22222222-2222-4222-8222-222222222222"]
  },
  "time": {
    "start": "2026-09-01T00:00:00Z",
    "end": "2026-09-07T23:59:59.999Z",
    "timezone": "UTC",
    "grain": "day"
  },
  "result_format": "rows",
  "limit": 100
}

For template-category delivery, use the request shape in Delivery by template category and add workspace_id to the MCP arguments. That page defines the supported dimensions, filters, rates, and category semantics. Marketing attribution supports cursor pagination; category delivery does not. See Analytics query for the shared request and response contract.

list_journeys

List journey summaries with trigger metadata, per-journey message stats, and status counts. The response also includes attribution_settings and attribution_by_journey_id.

Parameter	Description
`status`	`all`, `live`, `draft`, `paused`, or `archived`. Defaults to `all`.
`journey_classification`	`all`, `marketing`, or `utility`. Defaults to `all`.
`source`	Journey source filter. Defaults to `all`.
`search`	Text search over journey names.
`start_date`, `end_date`	Optional date range. Supply both or omit both. Use `get_journey_analytics` for an explicit reporting period.
`page`, `page_size`	Pagination. `page` defaults to 1; `page_size` defaults to 10 and is clamped to 1–100.

get_journey

Get one journey by ID. The response includes a flow summary with node and edge counts and counts by node type.

Parameter	Description
`journey_id`	Journey ID. Required.
`include_flow`	Set to `true` to also return the raw flow definition. The raw flow can be large, so leave it off unless you need node-level detail.

list_campaigns

List campaign summaries with per-campaign message stats. The response also includes attribution_settings, attribution_by_campaign_id, and voice_stats_by_campaign_id where available.

Parameter	Description
`status`	`all`, `DRAFT`, `CREATED`, `SCHEDULED`, `PREPARING`, `PREPARED`, `FIRING`, `COMPLETED`, `FAILED`, `CANCELLED`, or `PAUSED`. Defaults to `all`.
`campaign_type`	`all`, `journey`, or `single_message`. Defaults to `all`.
`search`	Text search over campaign names.
`start_date`, `end_date`	Optional date range. Supply both or omit both. Use `query_analytics` for an explicit attribution reporting period.
`page`, `page_size`	Pagination. `page` defaults to 1; `page_size` defaults to 10 and is clamped to 1–100.

get_campaign

Get one campaign’s current lifetime overview, including delivery stats, existing estimated cost stats, attribution, retry success count, and voice stats where applicable. The response includes time_scope: "lifetime". This tool has no reporting-date arguments. For date-scoped campaign attribution or workspace attribution defaults, use query_analytics as shown above.

Parameter	Description
`campaign_id`	Campaign ID. Required.
`attribution_type`	`delivery`, `read`, or `clicked`. Defaults to `delivery`.
`attribution_window_hours`	Attribution window in hours, 1–8760. Defaults to `72`.

​Choose a tool

​search_analytics_entities

​get_journey_analytics

​query_analytics

​list_journeys

​get_journey

​list_campaigns

​get_campaign