Journeys - API Documentation
Ⓔ Enterprise Only
This feature is available exclusively in Countly Enterprise.
Overview
Journey Engine lets you build automated journeys that react to user events, profile changes, and engagement actions. A journey definition can have multiple versions, with a single active version at a time. Journeys create instances per user, track block execution, and compute performance metrics.
Database Collections
| Collection | Purpose |
|---|---|
countly.journey_definition | Stores journey definitions (name, status, app, creator) |
countly.journey_versions | Stores journey versions and block graphs |
countly.journey_instances | Stores per-user journey execution instances |
countly.journey_logs | Stores journey instance status logs |
countly.journey_block_logs | Stores per-block execution logs |
countly.journey_stats | Stores aggregated journey performance stats (daily) |
countly.events | Stores app event metadata (created via journey event API) |
countly_drill.drill_meta | Stores drill event metadata for custom events |
countly.members | Journey creator lookups |
countly.apps | App metadata for journey lookups |
countly.app_users{appId} | User profiles for instance lookups |
countly.plugins | Stores plugin config (including journey_engine.cooldown migration data) |
Configuration & Settings
The feature uses config stored in the plugins document:
journey_engine.cooldown(hours, default: 24)- Used to throttle content delivery between journeys
- If missing, the setting is migrated from
content.cooldown
Quick Links
Journeys
- Save Journey -
/i/journey-engine/journeys/save - List Journeys -
/o/journey-engine/list - Get Journey -
/o/journey-engine/journey - Delete Journey -
/i/journey-engine/delete - Publish Journey -
/i/journey-engine/journeys/publish - Pause Journey -
/i/journey-engine/journeys/pause - Resume Journey -
/i/journey-engine/journeys/resume
Versions
- List Versions -
/o/journey-engine/versions/list - Save Version -
/i/journey-engine/versions/save - Rename Version -
/i/journey-engine/versions/rename - Duplicate Version -
/i/journey-engine/versions/duplicate - Activate Version -
/i/journey-engine/versions/activate - Delete Version -
/i/journey-engine/versions/delete
Stats
- Journey Results Table -
/o/journey-engine/stats/table - Summary Metrics -
/o/journey-engine/stats/summary - UIDs by Metric -
/o/journey-engine/stats/uids - Performance Over Time -
/o/journey-engine/stats/performance - Active Users -
/o/journey-engine/stats/active-users - Active Users Detail -
/o/journey-engine/stats/active-users/detail
Logs & Instances
- Journey Instances -
/o/journey-engine/journey-instances/list - Journey Logs -
/o/journey-enginge/journey-logs/list - Journey Block Logs -
/o/journey-engine/journey-block-logs/list
Utilities
- Create Custom Event -
/i/journey-engine/event - Init Engine (Internal) -
/i/journey-engine/init - Debug Journey (Admin) -
/o/journey-engine/debug
Permissions & Access
Most endpoints require the journey_engine feature permission. Some endpoints are restricted to global admins (see endpoint docs).
Related Features
- Content: Journey blocks can trigger content delivery
- Drill: Journey filters and events use Drill data
- Surveys: Survey events can advance journeys
Ⓔ Enterprise
This feature is part of Countly Enterprise.
Get Access:
Already a Customer? Use support portal if you have any questions
Last Updated
2026-02-16