Amplitude ACTION
List Cohorts
List all behavioral cohorts in the Amplitude project. Returns a
cohorts array; each entry defaults to id, name, size, lastMod, appId. Pass fields to get more, e.g. description, published, archived, or the large definition (the cohort's filter logic) / owners/viewers (email arrays). Use this to discover valid cohort IDs for Request Cohort Download (step 1 of 3, followed by Get Cohort Download Status and Download Cohort File, to fetch a cohort's member list). Example: call with no parameters -> returns {cohorts: [{id: "abc123", name: "Power Users Q3", size: 4200, lastMod: 1722873600000, appId: 849238}, ...]}. See the documentation.- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Amplitude account once, then configure and run List Cohorts 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: "amplitude-list-cohorts",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
amplitude: { authProvisionId: "apn_xxxxxxx" },
includeSyncInfo: true,
fields: ["Fields"],
},
})
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": "amplitude-list-cohorts",
"configured_props": {
"amplitude": { "authProvisionId": "apn_xxxxxxx" },
"includeSyncInfo": true,
"fields": ["Fields"]
}
}'// 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": "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-list-cohorts",
arguments: {
includeSyncInfo: true,
fields: ["Fields"],
},
})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 |
|---|---|---|
includeSyncInfo Include Sync Info | boolean | When true, include cohort sync metadata in the response (the includeSyncInfo param) — each cohort's syncMetadata field is then always kept regardless of fields. Optional |
fields Fields | string[] | Field names to return for each cohort ( id is always included). Defaults to: id, name, size, lastMod, appId. Also available: description, published, archived, createdAt, lastComputed, definition, owners, viewers, syncMetadata (auto-included when Include Sync Info is true). Pass only what you need to keep responses small. 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
- amplitude-list-cohorts
- Version
- 0.0.2
- App
- Amplitude
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗