/amplitude | Type: Application | PCID required: Yes
Amplitude Analytics API - pull reports, stats, and taxonomy data including active users, event segmentation, session metrics, event types/properties, user properties, and real-time data
Tools
| Tool | Description |
|---|---|
amplitude_get_user_search | Search for users based on properties |
amplitude_get_real_time_active_users | Get real-time active user counts |
amplitude_get_event_types | Get all event types in the project with metadata including category, description, activity status, and visibility. Similar to events/list but with richer taxonomy data |
amplitude_get_event_properties | Get all properties for a specific event type, including property name, description, type, and whether it is required |
amplitude_get_user_properties | Get all user properties in the project, including property name, description, type, and whether it is required |
amplitude_get_active_users | Get the number of active or new users over a date range, with optional segmentation and grouping |
amplitude_get_event_segmentation | Get metrics for an event with segmentation. Returns event counts (totals, uniques, or average) over a date range. Use event_type “_active” for any active event, “_all” for any event, or “ce:name” for custom events |
amplitude_get_events_list | Get the list of all visible events with this week’s totals, unique users, and % of daily active users |
amplitude_get_average_session_length | Get the average session length in seconds for each day in a date range |
amplitude_get_sessions_per_user | Get the average number of sessions per user on each day in a date range |
amplitude_get_retention | Get retention analysis — what percentage of users who performed a starting event come back and perform a return event over time. Core analytics metric for measuring user stickiness |
amplitude_get_user_search
Search for users based on properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user | string | Yes | — | User ID or Amplitude ID to search for |
getUserActivity | boolean | No | false | Include user activity in response |
amplitude_get_real_time_active_users
Get real-time active user counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
interval | string | No | "5" | Time interval in minutes |
amplitude_get_event_types
Get all event types in the project with metadata including category, description, activity status, and visibility. Similar to events/list but with richer taxonomy data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
showDeleted | boolean | No | false | Include deleted event types in the response |
amplitude_get_event_properties
Get all properties for a specific event type, including property name, description, type, and whether it is required Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventType | string | Yes | — | The event type name to get properties for (e.g. “SignUp”, “Purchase”) |
amplitude_get_user_properties
Get all user properties in the project, including property name, description, type, and whether it is requiredamplitude_get_active_users
Get the number of active or new users over a date range, with optional segmentation and grouping Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format, e.g. “20260101”) |
end | string | Yes | — | End date (YYYYMMDD format, e.g. “20260209”) |
m | string | No | "active" | Metric type: “active” or “new” users |
i | string | No | "1" | Interval: 1 (daily), 7 (weekly), 30 (monthly) |
g | string | No | — | Property to group by (e.g. “platform”, “country”, “city”, “os”). For custom user properties use “gp:name” format |
amplitude_get_event_segmentation
Get metrics for an event with segmentation. Returns event counts (totals, uniques, or average) over a date range. Use event_type “_active” for any active event, “_all” for any event, or “ce:name” for custom events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventType | string | Yes | — | Event type to analyze. Use “_active” for any active event, “_all” for any event, “revenue_amount” for revenue, or “ce:EventName” for custom events |
start | string | Yes | — | Start date (YYYYMMDD format, e.g. “20260101”) |
end | string | Yes | — | End date (YYYYMMDD format, e.g. “20260209”) |
m | string | No | "totals" | Metric: totals, uniques, average, pct_dau, or formula |
i | string | No | "1" | Interval: 1 (daily), 7 (weekly), 30 (monthly) |
g | string | No | — | Property to group by (e.g. “platform”, “country”). For custom user properties use “gp:name” format |
amplitude_get_events_list
Get the list of all visible events with this week’s totals, unique users, and % of daily active usersamplitude_get_average_session_length
Get the average session length in seconds for each day in a date range Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format, e.g. “20260101”) |
end | string | Yes | — | End date (YYYYMMDD format, e.g. “20260209”) |
amplitude_get_sessions_per_user
Get the average number of sessions per user on each day in a date range Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format, e.g. “20260101”) |
end | string | Yes | — | End date (YYYYMMDD format, e.g. “20260209”) |
amplitude_get_retention
Get retention analysis — what percentage of users who performed a starting event come back and perform a return event over time. Core analytics metric for measuring user stickiness Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
startEvent | string | No | "_active" | Starting event type. Use “_active” for any active event, “_all” for any event, or a specific event name. Defaults to “_active” |
returnEvent | string | No | "_active" | Return event type. Use “_active” for any active event, “_all” for any event, or a specific event name. Defaults to “_active” |
start | string | Yes | — | Start date (YYYYMMDD format, e.g. “20260101”) |
end | string | Yes | — | End date (YYYYMMDD format, e.g. “20260209”) |
rm | string | No | — | Retention mode: “rolling” (came back on day N or later) or “bracket” (came back within bracket). If omitted, Amplitude uses its default (n-day: came back on exactly day N) |

