Journey Engine - Stats Performance

Endpoint

/o/journey-engine/stats/performance

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Return performance metrics over time (users entered, completed, engaged, drop-off).

Authentication

• Authentication methods:
  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

• Required permission: Read on the journey_engine feature

Request Parameters

• journeyVersionId (optional): Filter by journey version
• journeyDefinitionId (optional): Filter by journey definition
• period (optional): Time period filter. Use "0days" for yearly aggregation

Response

Success Response

{
  "2024.01.01": {"usersEntered": 10, "usersCompleted": 2, "usersEngaged": 6, "usersDropOff": 1},
  "2024.01.02": {"usersEntered": 14, "usersCompleted": 3, "usersEngaged": 7, "usersDropOff": 2}
}

Response Fields

Field	Type	Description
(root object)	Object	Date/year keyed metric map.
<date>.usersEntered	Number	Users entered count for this bucket.
<date>.usersCompleted	Number	Users completed count for this bucket.
<date>.usersEngaged	Number	Users engaged count for this bucket.
<date>.usersDropOff	Number	Users drop-off count for this bucket.

Error Responses

• 500: Query error

Examples

GET /o/journey-engine/stats/performance?journeyDefinitionId=67164f4a1f1bd90d6354430a&period=30days

Behavior/Processing

• Filters journey_stats by journeyVersionId and/or journeyDefinitionId when provided.
• With period=0days, groups by year and returns year keys.
• With any other period, uses the current period date array, groups by YYYY.MM.DD, and fills missing dates with zero-value metric objects.
• Sorts buckets chronologically.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.journey_stats	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.

Related Endpoints

• No related endpoints

Ⓔ Enterprise

This feature is part of Countly Enterprise.

Get Access:

• Learn about Enterprise
• Contact Sales
• Compare Versions

Already a Customer? Use support portal if you have any questions

---

Last Updated

2026-04-18