Skip to main content

Journey Engine - Stats Uids

Endpoint​

/o/journey-engine/stats/uids

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

Overview​

Retrieve unique user IDs for a given stats metric (entered, engaged, completed, etc.).

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​

  • uidType (required): One of:
    • users_entered
    • users_engaged
    • users_completed
    • users_drop_off
    • content_viewed
    • content_interacted
  • journeyVersionId (optional): Filter by journey version
  • journeyDefinitionId (optional): Filter by journey definition
  • period (optional): Time period filter

Response​

Success Response​

{
  "uids": ["user_1", "user_2", "user_3"],
  "uidType": "users_entered",
  "total": 3
}

Response Fields​

FieldTypeDescription
uidsArrayUnique user IDs collected from the selected metric UID array.
uidTypeStringRequested UID metric type.
totalNumberNumber of returned unique user IDs.
errorStringError message returned for missing/invalid uidType or query failure.

Error Responses​

  • 400: Missing or invalid uidType
  • 500: Query error

Examples​

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

Behavior/Processing​

  • Requires uidType.
  • Accepts only users_entered, users_engaged, users_completed, content_viewed, content_interacted, and users_drop_off.
  • Filters journey_stats by journeyVersionId, journeyDefinitionId, and current period array when provided.
  • Reads from the matching <uidType>_uids array, unwinds values, groups unique ids, sorts by uid, and returns them as uids.

Database Collections​

CollectionUsed forData touched by this endpoint
countly.journey_statsEndpoint data sourceStores endpoint-related records this endpoint reads or modifies.
  • No related endpoints

Ⓔ Enterprise​

This feature is part of Countly Enterprise.

Get Access:

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

Last Updated​

2026-04-18