# Query Retention Report — Mixpanel (Service Account)

> 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…

- Key: `mixpanel_service_account-query-retention-report`
- Type: Action (Read-only)
- Version: 0.0.1
- App: Mixpanel (Service Account) (`mixpanel_service_account`) — https://pipedream.com/apps/mixpanel-service-account.md
- This page (HTML): https://pipedream.com/apps/mixpanel-service-account/actions/query-retention-report
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/mixpanel_service_account/actions/query-retention-report/query-retention-report.mjs

## Description

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](https://docs.mixpanel.com/reference/retention-query)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `fromDate` | `string` | Yes | Start of the query window in YYYY-MM-DD format (for example, 2026-07-01). Inclusive, and interpreted in the project's timezone. |
| `toDate` | `string` | Yes | End of the query window in YYYY-MM-DD format (for example, 2026-07-29). Inclusive, and interpreted in the project's timezone. |
| `retentionType` | `string` | Yes | 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. |
| `bornEvent` | `string` | No | 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. |
| `event` | `string` | No | The event that counts as coming back, exactly as tracked (for example, Viewed Report). Leave empty to count any event. |
| `unit` | `string` | No | 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. |
| `interval` | `integer` | No | 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. |
| `intervalCount` | `integer` | No | 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. |
| `unboundedRetention` | `boolean` | No | 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 |
| `bornWhere` | `string` | No | A segmentation expression that filters which Born Events qualify a user for a cohort. Example: properties["plan"] == "pro". See the expression syntax |
| `where` | `string` | No | A segmentation expression that filters which Returning Events count. Example: properties["$browser"] == "Chrome". See the expression syntax |
| `on` | `string` | No | A segmentation expression to break the returning users down by. Example: properties["$city"]. See the expression syntax |
| `limit` | `integer` | No | The maximum number of segment values to return. Has no effect unless Segment On is set. |
| `workspaceId` | `integer` | No | 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. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/mixpanel-service-account.md · All apps: https://pipedream.com/apps