# Request Cohort Download — Amplitude

> Start a behavioral cohort download job (step 1 of 3: request -> status -> download, per Amplitude's Behavioral Cohorts Download API). Returns a request_id — pass it to Get Cohort Download Status to poll until the job completes, then to…

- Key: `amplitude-request-cohort-download`
- Type: Action (Write)
- Version: 0.0.2
- App: Amplitude (`amplitude`) — https://pipedream.com/apps/amplitude.md
- This page (HTML): https://pipedream.com/apps/amplitude/actions/request-cohort-download
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/amplitude/actions/request-cohort-download/request-cohort-download.mjs

## Description

Start a behavioral cohort download job (step 1 of 3: request -> status -> download, per Amplitude's Behavioral Cohorts Download API). Returns a `request_id` — pass it to **Get Cohort Download Status** to poll until the job completes, then to **Download Cohort File** to fetch the member list. Use **List Cohorts** first to discover valid cohort IDs. Example: call with `cohortId="abc123"` -> returns `{request_id: "req_456", cohort_id: "abc123"}`. [See the documentation](https://amplitude.com/docs/apis/analytics/behavioral-cohorts#get-one-cohort).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `cohortId` | `string` | Yes | The ID of the cohort to download. This is a free-form string; run List Cohorts first to discover valid cohort IDs. Example: abc123. |
| `includeProperties` | `boolean` | No | When true, include each member's user properties in the downloaded file (the props param). If Property Keys is left empty, all available properties are returned. Leave unset for large cohorts that may time out when properties are requested. |
| `propertyKeys` | `string[]` | No | Specific user properties to include per member (the propKeys param), as an array of property name strings, e.g. ["plan", "country"]. Only used when Include User Properties is true; if left empty, all available properties are returned. |

## 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": "amplitude",
      },
    },
  },
)

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: "amplitude-request-cohort-download",
  arguments: {
    cohortId: "Cohort ID",
    includeProperties: true,
  },
})
```

**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: "amplitude-request-cohort-download",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    cohortId: "Cohort ID",
    includeProperties: true,
  },
})

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": "amplitude-request-cohort-download",
    "configured_props": {
      "amplitude": { "authProvisionId": "apn_xxxxxxx" },
      "cohortId": "Cohort ID",
      "includeProperties": true
    }
  }'
```

---

- App: https://pipedream.com/apps/amplitude.md · All apps: https://pipedream.com/apps