View as Markdown
Amplitude icon

Amplitude ACTION

Request Cohort Download

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.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Amplitude account once, then configure and run Request Cohort Download 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-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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Request Cohort Download inputs
Property Type Description
cohortId Cohort ID string
The ID of the cohort to download. This is a free-form string; run List Cohorts first to discover valid cohort IDs. Example: abc123.
Required
includeProperties Include User Properties boolean
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.
Optional
propertyKeys Property Keys string[]
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.
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-request-cohort-download
Version
0.0.2
App
Amplitude
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes