Register a Retention Query

Registers an asynchronous Retention analysis query and returns a request_id. Retention analysis groups users who performed a first event into cohorts, then measures how many return to perform a second event in each later period.

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

POST /v5/analytics/retention

Register a Retention Query

cURL

curl --request POST \
  --url https://api-{dc}.moengage.com/v5/analytics/retention \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "2.0",
  "type": "retention",
  "events": [
    {
      "id": "first",
      "actions": [
        {
          "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": []
            }
          }
        }
      ]
    },
    {
      "id": "return",
      "actions": [
        {
          "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"
            }
          ]
        }
      }
    }
  ],
  "timerange": {
    "start": "2026-07-07 00:00:00",
    "end": "2026-07-14 23:59:59",
    "label": "Last 7 Days",
    "dt_label": "last",
    "value": 7
  },
  "granularity": "d",
  "chart_type": "line",
  "retention_type": "every",
  "split_by": [],
  "comparison_timerange": {}
}
'

200

{
  "response_id": "79b86153-abfc-4499-9d24-c955636d74a2",
  "type": "retention",
  "data": {
    "request_id": "6a5622049f22da29f1ec05ee"
  }
}

{
  "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 Retention analysis query.

type · enum<string> · required

The analysis type. Must be retention for this endpoint.

Available options: retention

events · object[] · required

Exactly two events: the first event that places a user into a cohort, and the return event measured in later periods.

Required array length: 2 elements

Show child attributes

timerange · object · required

The time window the analysis runs over.

Show child attributes

retention_type · enum<string> · required

How return events are counted — every (return in every period), first (first return only), or last (last return only).

Available options: every, first, last

version · string

Payload schema version.

Example:

"2.0"

segmentation · object[]

Segments to scope the analysis (up to 5). Segmentation and comparison_timerange are mutually exclusive — do not send 2 or more segments together with a time comparison.

Maximum array length: 5

Show child attributes

granularity · enum<string>

Cohort period — h (hourly, window up to 24 hours), d (daily, up to 90 days), or w (weekly, up to 180 days).

Available options: h, d, w

Example:

"d"

chart_type · string

Visual representation of the result, such as line.

Example:

"line"

split_by · object[]

Attributes to break the cohorts down by. Include up to 10.

Maximum array length: 10

comparison_timerange · object

A second time range to compare against. Mutually exclusive with sending 2 or more segments. Pass an empty object for no comparison.

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