Journey Engine - Journey Block Logs List

Endpoint

/o/journey-engine/journey-block-logs/list

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

Overview

List block logs for a journey definition and aggregate app user IDs per block.

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

Requires global admin access.

Request Parameters

• journeyDefinitionId (required): Journey definition ID
• startTime (optional): Start time filter (ISO or ms)
• endTime (optional): End time filter (ISO or ms)
• appUserId (optional): Filter by app user ID

Response

Success Response

[
  {
    "_id": "block_1",
    "startTime": 1739239212000,
    "endTime": 1739239312000,
    "status": "completed",
    "journeyDefinitionId": "67164f4a1f1bd90d6354430a",
    "appUserIds": ["user_1", "user_2"]
  }
]

Response Fields

Field	Type	Description
(root value)	Array	Aggregated block log rows.
_id	String	Block ID.
startTime	Date or Number	First block log start time in the group.
endTime	Date or Number	First block log end time in the group.
status	String	First block log status in the group.
journeyDefinitionId	String	Journey definition ID.
appUserIds	Array	Unique app user IDs from joined journey instances.

Error Responses

• 400: Missing journeyDefinitionId
• 401: Not authorized
• 500: Query error

Examples

GET /o/journey-engine/journey-block-logs/list?journeyDefinitionId=67164f4a1f1bd90d6354430a&startTime=2024-01-01&endTime=2024-01-31

Behavior/Processing

• Requires the authenticated member to be a global admin.
• Requires journeyDefinitionId.
• Filters block logs by journeyDefinitionId and optional startTime/endTime.
• Joins journey_instances by journeyInstanceId and can filter joined instances by appUserId.
• Groups by blockId, returns first timing/status fields, and accumulates unique appUserIds.
• Sorts grouped rows by startTime ascending.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.journey_block_logs	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
countly.journey_instances	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