Get retention report with the Mixpanel API

Returns, for each cohort date, how many users entered the cohort (first) and how many came back in each interval after it (counts). Counts toward the Query API limit of 60 queries per hour.

Identifier
mixpanel_get_retention_report

The request

POST https://connect.reportei.com/api/tools/mixpanel_get_retention_report/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "project_id": 1,
    "from_date": "<from_date>",
    "to_date": "<to_date>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
project_idintegerYesId of the project, sent as a number: a key of results.projects in List projects, or the number after /project/ in the URL of Mixpanel.
workspace_idintegerNoOnly for projects that use data views: the id of the global data view, a key of results.workspaces in List projects, sent as a number.
from_datestringYesFirst day, inclusive, as YYYY-MM-DD.
to_datestringYesLast day, inclusive, as YYYY-MM-DD.
retention_typestringNobirth, the default, follows users from the first time they did born_event. compounded counts recurring returns.Values: birth, compounded
born_eventstringNoEvent that puts a user in a cohort, from List event names. Required when retention_type is birth.
eventstringNoEvent counted as a return, from List event names. Omit it to count any event.
born_wherestringNoExpression that filters the born events, for example properties["$os"] == "iOS".
wherestringNoExpression that filters the events of the query, for example properties["$browser"] == "Chrome".
unitstringNoUnit of the intervals. The default is day.Values: day, week, month
intervalintegerNoUnits in each interval. The default is 1, and with day it can be at most 90.
interval_countintegerNoNumber of intervals returned, besides the 0th interval for returns in less than one interval. The default is 1.
unbounded_retentionbooleanNotrue counts a user as retained in an interval when they came back in it or in any later one. The default is false.
onstringNoProperty expression that segments the return event, for example properties["$browser"]. The property names come from List event properties.
limitintegerNoMaximum number of segments when on is sent.

Supported connections

Your customer connects their Mixpanel account once, with one of the modes below. The same connection serves every tool of the toolkit.

Username and password

Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/mixpanel_get_retention_report. It becomes your agent's tool definition with no conversion.

Other Mixpanel tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.