View as Markdown
Amplitude icon

Amplitude ACTION

Get Retention Analysis

Compute retention (return rate) between a start event and a return event over a date range from the Amplitude Dashboard REST API. Example: call with startEvent={"event_type":"_new"}, returnEvent={"event_type":"_active"}, startDate="20240706", endDate="20240805" -> returns {data: {series: [[...retention counts per interval...]], seriesLabels: [...]}}. 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 Retention Analysis 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-retention-analysis",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    amplitude: { authProvisionId: "apn_xxxxxxx" },
    startEvent: "Start Event",
    returnEvent: "Return Event",
  },
})

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 Retention Analysis inputs
Property Type Description
startEvent Start Event string
JSON-encoded start event definition (the se param). Use a real event name, or Amplitude's built-in _new (new user) event. Example: {"event_type":"_new"}. Do NOT use the literal string "Any Active Event" — that's Amplitude UI label text, not a valid event_type value, and returns a 400.
Required
returnEvent Return Event string
JSON-encoded return event definition (the re param). Use a real event name, or Amplitude's built-in _active (active user) event. Example: {"event_type":"_active"}. Do NOT use the literal string "Any Active Event" — that's Amplitude UI label text, not a valid event_type value, and returns a 400.
Required
startDate Start Date string
Start date, inclusive, in YYYYMMDD format (the start param). Example: 20240706.
Required
endDate End Date string
End date, inclusive, in YYYYMMDD format (the end param). Example: 20240805.
Required
retentionMode Retention Mode string
Retention calculation mode (the rm param). One of bracket, rolling, nday. Defaults to nday. (Amplitude's own docs say n-day with a hyphen — that value is rejected by the live API with a 400; the working value is nday, no hyphen, confirmed directly against the API.) rolling returns an unbounded, much larger response — prefer nday unless you specifically need rolling retention, and if using rolling over a long date range, raise interval (e.g. to 7 or 30) to keep the response size manageable.
Optional
brackets Brackets string
Bracket day-ranges as a JSON-encoded array of [start, end] integer pairs, required only when Retention Mode is bracket (the rb param). Each pair is a day offset range (start must be ≤ end; Amplitude returns a 500 for a reversed range). Example: [[0,4]] for a single 0-4 day bracket, or [[0,4],[5,9]] for two brackets.
Optional
interval Interval integer
Time interval (the i param). One of 1 (daily), 7 (weekly), 30 (monthly). Defaults to 1 (daily), but daily granularity over a date range wider than ~2 weeks produces a very large response (one retention curve per day in range) that can exceed the MCP output limit. For any date range longer than 2 weeks, pass 7 (weekly) or 30 (monthly) instead of relying on the default.
Optional
segmentDefinitions Segment Definitions string
JSON-encoded array of segment definitions (the s param). Example: [{"prop":"country","op":"is","values":["US"]}].
Optional
groupBy Group By string
A single property name to group results by (the g param). Retention supports at most one group-by.
Optional
limit Limit integer
Maximum number of grouped values to return (the limit param). Min 1, max 1000. Defaults to 100. Amplitude has no cursor for this endpoint — values beyond this cap are silently dropped by the API, not just this tool. If more than limit distinct group-by values may exist, raise this toward 1000 or narrow with Segment Definitions/Group By.
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-get-retention-analysis
Version
0.0.2
App
Amplitude
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes