Read user funnels

Endpoint

/o?method=user_funnels

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

Overview

Returns funnels where a specific user appears, along with calculated progression data for that user context.

Authentication

Countly API supports three authentication methods:

1. API key query parameter: api_key=YOUR_API_KEY
2. Auth token query parameter: auth_token=YOUR_AUTH_TOKEN
3. Auth token header: countly-token: YOUR_AUTH_TOKEN

Permissions

Requires funnels Read permission.

Request Parameters

Parameter	Type	Required	Description
method	String	Yes	Must be user_funnels.
app_id	String	Yes	Target app ID.
uid	String	Yes	User ID to evaluate.
period	String or JSON String (Array/Object)	No	Analysis period.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

Configuration Impact

Setting	Default	Affects	User-visible impact
api.*	Server API defaults	Shared API execution controls (for example processing thresholds/limits).	Changes to API-level controls can affect runtime behavior, limits, or response timing for this endpoint.

Response

Success Response

[
  {
    "_id": "67f1c22912df5acb8f8d5caaf0f89a31",
    "name": "Purchase Funnel",
    "steps": ["Product View", "Add to Cart", "Purchase"],
    "step": 2,
    "data": {
      "total_users": 1,
      "success_users": 0,
      "success_rate": 0,
      "steps": [
        {"step": "Product View", "users": 1},
        {"step": "Add to Cart", "users": 1},
        {"step": "Purchase", "users": 0}
      ]
    }
  }
]

Response Fields

Field	Type	Description
[]	Array	Funnels in which user appeared in at least first step.
[].step	Number	Number of contiguous steps the user progressed through.
[].data	Object	Per-funnel calculated data payload for the user filter.

Error Responses

No explicit error response path; on calculation/query failures endpoint returns an empty array.

Behavior/Processing

• Loads all funnels for the app.
• Runs funnel calculation for each funnel with { uid: <uid> } filter.
• Returns only funnels where computed user progression is greater than zero.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.funnels	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
countly_drill.drill_events	Drill event records	Stores granular event rows queried or updated by this endpoint.
countly.app_users{appId}	Per-app user profiles	Stores user-level properties and profile fields affected by this endpoint.

---

Examples

/o?
  method=user_funnels&
  app_id=64f5c0d8f4f7ac0012ab3456&
  uid=1234567890abcdef&
  period=30days

---

Related Endpoints

• Funnels - Analyze
• Funnels - Read

---

Last Updated

2026-02-16