/amplitude | Type: Application | PCID required: Yes
Tools
amplitude_list_annotations
List Annotationsamplitude_create_annotation
Create Annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
date | string | Yes | — | Date for the annotation (YYYY-MM-DD format) |
details | string | No | — | Detailed description |
label | string | Yes | — | Label/title for the annotation |
amplitude_get_annotation
Get Annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
annotationId | string | Yes | — | Annotation Id |
amplitude_update_annotation
Update Annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
annotationId | string | Yes | — | Annotation Id |
date | string | No | — | Updated date (YYYY-MM-DD format) |
details | string | No | — | Updated details |
label | string | No | — | Updated label |
amplitude_delete_annotation
Delete Annotation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
annotationId | string | Yes | — | Annotation Id |
amplitude_get_chart_results
Get Chart Results Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
chartId | string | Yes | — | Chart ID from the URL in Amplitude web app |
amplitude_list_cohorts
List Cohortsamplitude_get_cohort
Get Cohort Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cohortId | string | Yes | — | The cohort ID to retrieve |
amplitude_download_cohort
Download Cohort Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cohortId | string | Yes | — | The cohort ID to download |
props | string | No | 0 | Set to 1 to include user properties in the download |
propKeys | string | No | — | Comma-separated list of user property keys to include (requires props=1) |
amplitude_get_user_composition
Get User Composition Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
p | string | Yes | — | Property to get composition of. Built-in: version, country, city, region, DMA, language, platform, os, device, start_version, paying. Custom: prefix with gp: |
amplitude_get_deletion_requests
Get Deletion Requests Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start_day | string | No | — | Start date filter (YYYY-MM-DD) |
end_day | string | No | — | End date filter (YYYY-MM-DD) |
amplitude_request_user_deletion
Request User Deletion Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
amplitude_ids | string[] | Yes | — | List of Amplitude IDs to delete |
requester | string | Yes | — | Email of the person requesting deletion |
user_ids | string[] | No | — | Alternative - list of User IDs to delete |
amplitude_get_events_list
List Eventsamplitude_get_event_segmentation
Get Event Segmentation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
e | string | Yes | — | Event definition as JSON: {“event_type”: “your_event”}. Prefix custom events with ce:. Use _active for any active event. |
e2 | string | No | — | Optional second event definition (same format as e) |
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
m | string | No | "uniques" | Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula |
n | string | No | — | User type: any or active |
i | string | No | "1" | Interval: -300000 (real-time), -3600000 (hourly), 1 (daily), 7 (weekly), 30 (monthly) |
s | string | No | — | Segment definitions as JSON array |
g | string | No | — | Property to group by (limit 2). Only available with single segment. |
limit | number | No | — | Limit number of group-by values returned |
amplitude_export_project_data
Export Project Data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start datetime (YYYYMMDDTHH format, e.g. 20210101T05) |
end | string | Yes | — | End datetime (YYYYMMDDTHH format, e.g. 20210102T20) |
amplitude_get_funnel_analysis
Get Funnel Analysis Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
e | string | Yes | — | First event in funnel as JSON: {“event_type”: “step_1”} |
e2 | string | No | — | Second event in funnel |
e3 | string | No | — | Third event in funnel (up to e10 supported) |
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
mode | string | No | "ordered" | Funnel mode: ordered (default) or unordered |
n | string | No | — | Funnel counting mode. Some projects use totals/uniques, others use active/new. |
cs | number | No | — | Conversion window in seconds |
s | string | No | — | Segment definitions as JSON array |
amplitude_get_real_time_active_users
Get Real-time Active Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
i | string | No | "5" | Interval in minutes: 5 (default), 15, or 60 |
amplitude_get_retention_analysis
Get Retention Analysis Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
se | string | Yes | — | Starting event as JSON: {“event_type”: “signup”} |
re | string | Yes | — | Returning event as JSON: {“event_type”: “login”} |
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
rm | string | No | — | Retention mode: bracket or rolling |
s | string | No | — | Segment definitions as JSON array |
amplitude_get_revenue_ltv
Get Revenue LTV Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
m | string | No | — | Metric: 0 for ARPPU, 1 for ARPU, 2 for total revenue, 3 for paying users |
i | string | No | "1" | Interval: 1 (daily), 7 (weekly), 30 (monthly) |
s | string | No | — | Segment definitions as JSON array |
g | string | No | — | Property to group by |
amplitude_get_average_session_length
Get Average Session Length Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
amplitude_get_session_length_distribution
Get Session Length Distribution Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
timeHistogramConfigBinTimeUnit | string | No | — | Time unit for bucket sizes: hours, minutes, or seconds |
timeHistogramConfigBinMin | number | No | — | Minimum value for bucketing |
timeHistogramConfigBinMax | number | No | — | Maximum value for bucketing |
timeHistogramConfigBinSize | number | No | — | Size of each bucket |
amplitude_get_average_sessions_per_user
Get Average Sessions Per User Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
amplitude_list_event_types
List Event Typesamplitude_list_event_properties
List Event Properties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type | string | Yes | — | The event type to list properties for |
amplitude_get_event_type
Get Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventType | string | Yes | — | The event type name |
amplitude_update_event_type
Update Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
eventType | string | Yes | — | The event type name |
description | string | No | — | New description |
display_name | string | No | — | New display name |
visible | boolean | No | — | Whether the event should be visible |
amplitude_list_user_properties
List User Propertiesamplitude_get_user_activity
Get User Activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user | string | Yes | — | Amplitude ID of the user |
offset | number | No | 0 | Offset for pagination (0-indexed) |
limit | number | No | 1000 | Number of events to return (max 1000) |
amplitude_get_active_new_users
Get Active/New User Counts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | string | Yes | — | Start date (YYYYMMDD format) |
end | string | Yes | — | End date (YYYYMMDD format) |
m | string | No | "active" | User metric: active or new |
i | string | No | "1" | Interval: 1 (daily), 7 (weekly), 30 (monthly) |
s | string | No | — | Segment definitions as JSON array |
g | string | No | — | Property to group by |
amplitude_get_user_search
Search Users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user | string | Yes | — | User ID, device ID, or Amplitude ID to search for |

