Journey Engine - Stats Active Users Detail

Endpoint

/o/journey-engine/stats/active-users/detail

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

Overview

Return active user counts grouped by interval (daily, weekly, monthly).

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
• interval (optional): daily, weekly, or monthly (default: daily)

Response

Success Response

[
  {"_id": {"year": 2024, "month": 1, "day": 1}, "activeUsers": 20},
  {"_id": {"year": 2024, "month": 1, "day": 2}, "activeUsers": 30}
]

Response Fields

Field	Type	Description
(root value)	Array	Aggregated active-user buckets.
_id.year	Number	Bucket year.
_id.month	Number	Bucket month for daily/monthly/weekly intervals.
_id.week	Number	Bucket week for daily/weekly intervals.
_id.day	Number	Bucket day for daily interval.
activeUsers	Number	Sum of users_completed for the bucket.

Error Responses

• 500: Query error

Examples

GET /o/journey-engine/stats/active-users/detail?journeyDefinitionId=67164f4a1f1bd90d6354430a&period=30days&interval=daily

Behavior/Processing

• Uses Countly period helpers to build the current period date array.
• Filters by journeyVersionId and/or journeyDefinitionId when provided.
• Groups by daily, weekly, or monthly; any other interval falls back to an empty group key.
• Sorts by year, month, week, and day.

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