Register a Funnels Query

Registers an asynchronous Funnels analysis query and returns a request_id. Funnels analysis measures step-by-step conversion and drop-off across an ordered sequence of events.

Use the request_id with Get Query Status to poll for completion, then Get Query Results to fetch the resolved series.

POST /v5/analytics/funnels

Register a Funnels Query

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v5/analytics/funnels \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    {
      "from_step": null,
      "to_step": null,
      "step_type": "include",
      "step_number": 1,
      "c_at_trigger_seg_v2": {
        "included_filters": {
          "filter_operator": "and",
          "filters": [
            {
              "filter_type": "actions",
              "action_name": "MOE_APP_OPENED",
              "execution": {
                "type": "atleast",
                "count": 1
              },
              "executed": true,
              "attributes": {
                "filter_operator": "and",
                "filters": []
              }
            }
          ]
        }
      },
      "c_at_act_seg_v2": {
        "included_filters": {
          "filter_operator": "and",
          "filters": []
        }
      }
    },
    {
      "from_step": null,
      "to_step": null,
      "step_type": "include",
      "step_number": 2,
      "c_at_trigger_seg_v2": {
        "included_filters": {
          "filter_operator": "and",
          "filters": [
            {
              "filter_type": "actions",
              "action_name": "UPDATE",
              "execution": {
                "type": "atleast",
                "count": 1
              },
              "executed": true,
              "attributes": {
                "filter_operator": "and",
                "filters": []
              }
            }
          ]
        }
      },
      "c_at_act_seg_v2": {
        "included_filters": {
          "filter_operator": "and",
          "filters": []
        }
      }
    }
  ],
  "segmentation": [
    {
      "filters": {
        "included_filters": {
          "filter_operator": "and",
          "filters": [
            {
              "id": "moe_all_users",
              "name": "All Users",
              "filter_type": "custom_segments"
            }
          ]
        }
      }
    }
  ],
  "funnel_type": "user_funnel",
  "timerange": {
    "start": "2026-07-07 00:00:00",
    "end": "2026-07-14 23:59:59",
    "label": "Last 7 Days",
    "dt_label": "last",
    "value": 7
  },
  "grouped_by_meta": {},
  "grouped_by": [],
  "holding_attributes_meta": {},
  "holding_attributes": [],
  "funnel_window": 86400,
  "funnel_window_multiplier": 86400,
  "strict_order": false,
  "distribution": {},
  "countType": "number",
  "showConversionEventOnly": false,
  "chart_type": "column",
  "comparison_timerange": {},
  "version": "2.0",
  "type": "funnel",
  "granularity": "e",
  "chart_plot_type": "linear"
}
'

200

{
  "response_id": "498b1a8f-027b-4aba-b71e-2f6fac76deba",
  "type": "funnels",
  "data": {
    "request_id": "6a5621f99f22da29f1ec05ed"
  }
}

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "analysis_type - Enum doesnt allow value: eventsdfg, allowed values: [events, users, session, aggregation, aggregation_distribution, total_events_per_user, attribute_aggregation_per_user] : 'eventsdfg'",
    "doc_url": "/api/analytics-query/analytics-query-overview"
  },
  "response_id": "01306019-419a-4728-ad82-9d522464f33a"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required.",
    "doc_url": "/api/analytics-query/analytics-query-overview"
  },
  "response_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have access to perform this action.",
    "doc_url": "/api/analytics-query/analytics-query-overview"
  },
  "response_id": "c9d0e1f2-a3b4-4c5d-9e6f-7a8b9c0d1e2f"
}

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Your workspace has reached its monthly Fair Usage Policy limit for analytics usage. Please contact your Customer Success Manager to expand your quota.",
    "doc_url": "/api/analytics-query/analytics-query-overview"
  },
  "response_id": "714b4690eba1deb53b065d92277e2910"
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred while processing the request.",
    "doc_url": "/api/analytics-query/analytics-query-overview"
  },
  "response_id": "dcc4fd00-2980-41a5-94b3-ad4844ae3d72"
}

Authorizations

Authorization · string · header · required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format username:password.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your Data API Key, which you can find in the MoEngage dashboard at Settings > Account > APIs.

For more information, see Authentication.

Body

application/json

Request body for registering a Funnels analysis query.

type · enum<string> · required

The analysis type. Must be funnel for this endpoint.

Available options: funnel

events · object[] · required

The ordered steps of the funnel. Include 2 to 10 steps. Each step defines the event and attribute conditions a user must satisfy to be counted at that step.

Required array length: 2 - 10 elements

Show child attributes

funnel_type · enum<string> · required

The kind of funnel to compute — user_funnel (standard conversion), event_time_to_convert (time-to-convert distribution between two steps), or user_frequency (frequency distribution of repeated actions between two steps).

Available options: user_funnel, event_time_to_convert, user_frequency

timerange · object · required

The time window the analysis runs over.

Show child attributes

version · string

Payload schema version.

Example:

"2.0"

segmentation · object[]

Segments used to scope the analysis to a subset of users. Include up to 5 segments. To analyze all users, pass a single segment with the All Users custom segment.

Maximum array length: 5

Show child attributes

grouped_by · object[]

Attributes to split the funnel by. Include up to 3.

Maximum array length: 3

grouped_by_meta · object

Metadata for the grouped_by attributes.

holding_attributes · object[]

Attributes held constant across funnel steps. Include up to 3.

Maximum array length: 3

holding_attributes_meta · object

Metadata for the holding_attributes.

funnel_window · integer

The conversion window in seconds within which users must complete the funnel.

Example:

86400

funnel_window_multiplier · integer

Multiplier applied to the funnel window.

Example:

86400

strict_order · boolean

Whether steps must be performed in the exact order defined.

Example:

false

distribution · object

Distribution configuration for event_time_to_convert and user_frequency funnels. When using custom buckets, include at most 25 buckets. Pass an empty object for a standard funnel.

countType · string

Whether metrics are returned as absolute counts or percentages, such as number.

Example:

"number"

showConversionEventOnly · boolean

Whether to return only the conversion event's metrics.

Example:

false

chart_type · string

Visual representation of the result, such as line, bar, or column.

Example:

"column"

comparison_timerange · object

A second time range to compare against. Time comparison is supported only on line, bar, and column charts, and cannot be combined with custom-segment comparison (2 or more segments). Pass an empty object for no comparison.

granularity · enum<string>

Time bucket for the series — h (hour), d (day), w (week), m (month), or e (entire range). When hourly, the time range must not exceed 31 days.

Available options: h, d, w, m, e

Example:

"e"

chart_plot_type · string

Plot scale for the chart, such as linear.

Example:

"linear"

Response

200

application/json

Query registered. Poll status and fetch results with data.request_id.

Acknowledgement that a query was registered. Use data.request_id to poll status and fetch results.

response_id · string

A unique identifier for the response, useful for correlating logs and support requests.

Example:

"fc803857-632e-4bf0-8df1-fbc2bdeedb66"

type · string

The analysis type echoed back for the registered query.

data · object

Show child attributes