Mixpanel (Service Account) ACTION
Query Retention Report
Run a cohort retention analysis: of the users who first did one event, how many came back and did another over the following intervals. Answers questions like "what does week-4 retention look like for users who signed up in June?". The response maps each cohort date to a
first count and a counts array, one entry per interval. See the documentation- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Mixpanel (Service Account) account once, then configure and run Query Retention Report from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "mixpanel_service_account-query-retention-report",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
mixpanel_service_account: { authProvisionId: "apn_xxxxxxx" },
fromDate: "From Date",
toDate: "To Date",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "mixpanel_service_account-query-retention-report",
"configured_props": {
"mixpanel_service_account": { "authProvisionId": "apn_xxxxxxx" },
"fromDate": "From Date",
"toDate": "To Date"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "mixpanel_service_account",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "mixpanel_service_account-query-retention-report",
arguments: {
fromDate: "From Date",
toDate: "To Date",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
fromDate From Date | string | Start of the query window in YYYY-MM-DD format (for example, 2026-07-01). Inclusive, and interpreted in the project's timezone. Required |
toDate To Date | string | End of the query window in YYYY-MM-DD format (for example, 2026-07-29). Inclusive, and interpreted in the project's timezone. Required |
retentionType Retention Type | string | Which kind of retention to measure. One of birth (first-time retention, measured from each user's first Born Event) or compounded (recurring retention, measured from every qualifying event). Defaults to birth. Required |
bornEvent Born Event | string | The event that puts a user into a cohort, exactly as tracked (for example, Signed Up). Required when Retention Type is birth; ignored when it is compounded. Optional |
event Returning Event | string | The event that counts as coming back, exactly as tracked (for example, Viewed Report). Leave empty to count any event. Optional |
unit Unit | string | The unit that Interval is counted in: day, week, or month. For example, Unit week with an Interval of 4 gives four-week retention intervals. Mixpanel defaults to day when this is left empty. Optional |
interval Interval | integer | How many Unit values make up a single retention interval, for example 7. Defaults to 1, and may not exceed 90 when Unit is day or left empty. Optional |
intervalCount Interval Count | integer | How many intervals to return per cohort. Defaults to 1. Note that a "0th" interval is included for users who returned less than one interval after the Born Event. Optional |
unboundedRetention Unbounded Retention | boolean | When true, interval N counts users who returned on interval N or on any interval after it, accumulating right to left. Defaults to false. Learn more about counting methods Optional |
bornWhere Born Where | string | A segmentation expression that filters which Born Events qualify a user for a cohort. Example: properties["plan"] == "pro". See the expression syntax Optional |
where Where | string | A segmentation expression that filters which Returning Events count. Example: properties["$browser"] == "Chrome". See the expression syntax Optional |
on Segment On | string | A segmentation expression to break the returning users down by. Example: properties["$city"]. See the expression syntax Optional |
limit Limit | integer | The maximum number of segment values to return. Has no effect unless Segment On is set. Optional |
workspaceId Workspace ID | integer | The ID of the Data View to query. Only needed for projects that use Data Views; leave it empty otherwise. It is the segment after /view/ in a project URL such as https://mixpanel.com/project/1234/view/5678/app/boards. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- mixpanel_service_account-query-retention-report
- Version
- 0.0.1
- App
- Mixpanel (Service Account)
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗