View as Markdown
Amplitude icon

Amplitude ACTION

Download Cohort File

Download a completed cohort export's member list (step 3 of 3: request -> status -> download). Call Request Cohort Download then Get Cohort Download Status first, and only call this once status is JOB COMPLETED — calling it earlier will fail. Returns one record per member (amplitude_id/user_id, plus any requested user properties) — not the cohort's own metadata (name, size, definition); use List Cohorts for that. Example: call with requestId="req_456" -> returns {requestId: "req_456", memberCount: 4200, returnedCount: 4200, truncated: false, members: [{amplitude_id: "123456789", user_id: "user@example.com"}, ...]}. 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 Download Cohort File 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-download-cohort-file",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    requestId: "Request ID",
    maxMembers: 10,
  },
})

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.

Download Cohort File inputs
Property Type Description
requestId Request ID string
The request_id returned by Request Cohort Download, after Get Cohort Download Status reports JOB COMPLETED. Example: req_456.
Required
maxMembers Max Members integer
Maximum number of member records to return. Defaults to 10000. The true total is always reported in memberCount, with truncated: true if it exceeds this cap.
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-download-cohort-file
Version
0.0.2
App
Amplitude
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes