Skip to content

Group journeys and run them together

A journey group bundles related journeys so you can audit them in one call — every checkout flow, say, or everything a signed-out visitor can reach.

create_journey_group(organization_id, project_id, name: "Checkout", description: "Guest and signed-in purchase flows")

The group starts empty. Creating it does not move any journeys into it.

Membership is set, not appended:

set_journey_group_members(organization_id, journey_group_id, journey_ids: ["jrn_a", "jrn_b"])

This replaces the whole member list. Pass the complete desired set every time, never a delta — sending one id does not add one journey, it leaves the group with exactly that one journey. To add to a group, read its current members with list_journey_groups first and send the union.

The call returns the group with its updated members and journey count.

run_journey_group(organization_id, project_id, journey_group_id)

This starts one audit run per member journey, and one journey failing to start does not stop the others. The response sorts the journeys into three groups:

Started 2 audits (run ids: run_a, run_b). 1 already had a run in flight: Guest checkout (run_c). Skipped 1 (over quota or refused): Password reset.

Read all three before you treat the group as covered:

  • Started — new runs, one per journey.
  • Already had a run in flight — nothing new was started, because an audit of that journey was already going. You get the id of the run that is running, so you can watch or cancel it like any other. This is not a failure.
  • Skipped — did not start and is not running. Over quota, or refused for another reason. These are the ones to come back to.

run_journey_group hands back run ids directly, where start_agentic_audit hands back a request id you resolve by polling. Use those run ids with get_agentic_audit_report and cancel_audit.

update_journey_group(organization_id, journey_group_id, name, description)
delete_journey_group(organization_id, journey_group_id)

update_journey_group does not touch membership. Deleting a group deletes only the grouping — the member journeys survive.

Full arguments: journey group tools.