View as Markdown
Amplitude icon

Amplitude ACTION

Get Cohort Download Status

Check whether a cohort download job has finished (step 2 of 3: request -> status -> download). Call Request Cohort Download first to get a requestId. This action polls internally for up to ~35 seconds before returning, since Amplitude's export jobs commonly take 30-60+ seconds regardless of cohort size. If the returned async_status is still JOB INPROGRESS, call this action again with the same request ID (it may take a few calls) — do not call Download Cohort File until async_status is JOB COMPLETED. Example: call with requestId="req_456" -> returns {request_id: "req_456", cohort_id: "abc123", async_status: "JOB COMPLETED"}. 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 Get Cohort Download Status 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-get-cohort-download-status",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    requestId: "Request ID",
  },
})

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.

Get Cohort Download Status inputs
Property Type Description
requestId Request ID string
The request_id returned by Request Cohort Download. Example: req_456.
Required

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-get-cohort-download-status
Version
0.0.2
App
Amplitude
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes