Analytics Query APIs Overview

Run MoEngage Analytics queries — Behavior, Funnels, Retention, Session/Source, and User Property Analysis — and fetch their results programmatically.

The Analytics Query APIs let you run MoEngage’s analysis queries programmatically and retrieve their results. They cover the same analyses available in the MoEngage dashboard: Behavior, Funnels, Retention, Session/Source (BFRS), and User Property Analysis (UPA).

These queries are asynchronous. A POST registers the query and returns a request_id immediately; the query runs in the background; you then poll for status and fetch the results.

Endpoints

The Analytics Query APIs include the following endpoints:

• Register a Behavior Query: Run a Behavior analysis.
• Register a Funnels Query: Run a Funnels analysis.
• Register a Retention Query: Run a Retention analysis.
• Register a Session-Source Query: Run a Session/Source analysis.
• Register a User Analysis Query: Run a User Property Analysis.
• Get Query Status: Check the execution status of a registered query.
• Get Query Results: Fetch the resolved results of a completed query.

Typical Workflow

Each analysis follows the same submit → poll → fetch sequence:

1. Submit the query by calling one of the analysis endpoints (for example, Register a Behavior Query). The response echoes the analysis type and returns a request_id.
2. Poll Get Query Status with that request_id until status is SUCCESSFUL (or FAILED).
3. Fetch Get Query Results with the same request_id to retrieve the results. The shape of the data array depends on the analysis type.

Authentication

These endpoints use the same HTTP Basic authentication as MoEngage’s other v5 APIs: your MoEngage App ID as the username and your DATA API key as the password. Refer to API keys for details.

Postman Collection