Skip to main content
Server path: /amplitude | Type: Application | PCID required: Yes

Tools

ToolDescription
amplitude_list_annotationsList Annotations
amplitude_create_annotationCreate Annotation
amplitude_get_annotationGet Annotation
amplitude_update_annotationUpdate Annotation
amplitude_delete_annotationDelete Annotation
amplitude_get_chart_resultsGet Chart Results
amplitude_list_cohortsList Cohorts
amplitude_get_cohortGet Cohort
amplitude_download_cohortDownload Cohort Users
amplitude_get_user_compositionGet User Composition
amplitude_get_deletion_requestsGet Deletion Requests
amplitude_request_user_deletionRequest User Deletion
amplitude_get_events_listList Events
amplitude_get_event_segmentationGet Event Segmentation
amplitude_export_project_dataExport Project Data
amplitude_get_funnel_analysisGet Funnel Analysis
amplitude_get_real_time_active_usersGet Real-time Active Users
amplitude_get_retention_analysisGet Retention Analysis
amplitude_get_revenue_ltvGet Revenue LTV
amplitude_get_average_session_lengthGet Average Session Length
amplitude_get_session_length_distributionGet Session Length Distribution
amplitude_get_average_sessions_per_userGet Average Sessions Per User
amplitude_list_event_typesList Event Types
amplitude_list_event_propertiesList Event Properties
amplitude_get_event_typeGet Event Type
amplitude_update_event_typeUpdate Event Type
amplitude_list_user_propertiesList User Properties
amplitude_get_user_activityGet User Activity
amplitude_get_active_new_usersGet Active/New User Counts
amplitude_get_user_searchSearch Users

amplitude_list_annotations

List Annotations

amplitude_create_annotation

Create Annotation Parameters:
ParameterTypeRequiredDefaultDescription
datestringYesDate for the annotation (YYYY-MM-DD format)
detailsstringNoDetailed description
labelstringYesLabel/title for the annotation

amplitude_get_annotation

Get Annotation Parameters:
ParameterTypeRequiredDefaultDescription
annotationIdstringYesAnnotation Id

amplitude_update_annotation

Update Annotation Parameters:
ParameterTypeRequiredDefaultDescription
annotationIdstringYesAnnotation Id
datestringNoUpdated date (YYYY-MM-DD format)
detailsstringNoUpdated details
labelstringNoUpdated label

amplitude_delete_annotation

Delete Annotation Parameters:
ParameterTypeRequiredDefaultDescription
annotationIdstringYesAnnotation Id

amplitude_get_chart_results

Get Chart Results Parameters:
ParameterTypeRequiredDefaultDescription
chartIdstringYesChart ID from the URL in Amplitude web app

amplitude_list_cohorts

List Cohorts

amplitude_get_cohort

Get Cohort Parameters:
ParameterTypeRequiredDefaultDescription
cohortIdstringYesThe cohort ID to retrieve

amplitude_download_cohort

Download Cohort Users Parameters:
ParameterTypeRequiredDefaultDescription
cohortIdstringYesThe cohort ID to download
propsstringNo0Set to 1 to include user properties in the download
propKeysstringNoComma-separated list of user property keys to include (requires props=1)

amplitude_get_user_composition

Get User Composition Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
pstringYesProperty 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:
ParameterTypeRequiredDefaultDescription
start_daystringNoStart date filter (YYYY-MM-DD)
end_daystringNoEnd date filter (YYYY-MM-DD)

amplitude_request_user_deletion

Request User Deletion Parameters:
ParameterTypeRequiredDefaultDescription
amplitude_idsstring[]YesList of Amplitude IDs to delete
requesterstringYesEmail of the person requesting deletion
user_idsstring[]NoAlternative - list of User IDs to delete

amplitude_get_events_list

List Events

amplitude_get_event_segmentation

Get Event Segmentation Parameters:
ParameterTypeRequiredDefaultDescription
estringYesEvent definition as JSON: {“event_type”: “your_event”}. Prefix custom events with ce:. Use _active for any active event.
e2stringNoOptional second event definition (same format as e)
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
mstringNo"uniques"Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula
nstringNoUser type: any or active
istringNo"1"Interval: -300000 (real-time), -3600000 (hourly), 1 (daily), 7 (weekly), 30 (monthly)
sstringNoSegment definitions as JSON array
gstringNoProperty to group by (limit 2). Only available with single segment.
limitnumberNoLimit number of group-by values returned

amplitude_export_project_data

Export Project Data Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart datetime (YYYYMMDDTHH format, e.g. 20210101T05)
endstringYesEnd datetime (YYYYMMDDTHH format, e.g. 20210102T20)

amplitude_get_funnel_analysis

Get Funnel Analysis Parameters:
ParameterTypeRequiredDefaultDescription
estringYesFirst event in funnel as JSON: {“event_type”: “step_1”}
e2stringNoSecond event in funnel
e3stringNoThird event in funnel (up to e10 supported)
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
modestringNo"ordered"Funnel mode: ordered (default) or unordered
nstringNoFunnel counting mode. Some projects use totals/uniques, others use active/new.
csnumberNoConversion window in seconds
sstringNoSegment definitions as JSON array

amplitude_get_real_time_active_users

Get Real-time Active Users Parameters:
ParameterTypeRequiredDefaultDescription
istringNo"5"Interval in minutes: 5 (default), 15, or 60

amplitude_get_retention_analysis

Get Retention Analysis Parameters:
ParameterTypeRequiredDefaultDescription
sestringYesStarting event as JSON: {“event_type”: “signup”}
restringYesReturning event as JSON: {“event_type”: “login”}
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
rmstringNoRetention mode: bracket or rolling
sstringNoSegment definitions as JSON array

amplitude_get_revenue_ltv

Get Revenue LTV Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
mstringNoMetric: 0 for ARPPU, 1 for ARPU, 2 for total revenue, 3 for paying users
istringNo"1"Interval: 1 (daily), 7 (weekly), 30 (monthly)
sstringNoSegment definitions as JSON array
gstringNoProperty to group by

amplitude_get_average_session_length

Get Average Session Length Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)

amplitude_get_session_length_distribution

Get Session Length Distribution Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
timeHistogramConfigBinTimeUnitstringNoTime unit for bucket sizes: hours, minutes, or seconds
timeHistogramConfigBinMinnumberNoMinimum value for bucketing
timeHistogramConfigBinMaxnumberNoMaximum value for bucketing
timeHistogramConfigBinSizenumberNoSize of each bucket

amplitude_get_average_sessions_per_user

Get Average Sessions Per User Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)

amplitude_list_event_types

List Event Types

amplitude_list_event_properties

List Event Properties Parameters:
ParameterTypeRequiredDefaultDescription
event_typestringYesThe event type to list properties for

amplitude_get_event_type

Get Event Type Parameters:
ParameterTypeRequiredDefaultDescription
eventTypestringYesThe event type name

amplitude_update_event_type

Update Event Type Parameters:
ParameterTypeRequiredDefaultDescription
eventTypestringYesThe event type name
descriptionstringNoNew description
display_namestringNoNew display name
visiblebooleanNoWhether the event should be visible

amplitude_list_user_properties

List User Properties

amplitude_get_user_activity

Get User Activity Parameters:
ParameterTypeRequiredDefaultDescription
userstringYesAmplitude ID of the user
offsetnumberNo0Offset for pagination (0-indexed)
limitnumberNo1000Number of events to return (max 1000)

amplitude_get_active_new_users

Get Active/New User Counts Parameters:
ParameterTypeRequiredDefaultDescription
startstringYesStart date (YYYYMMDD format)
endstringYesEnd date (YYYYMMDD format)
mstringNo"active"User metric: active or new
istringNo"1"Interval: 1 (daily), 7 (weekly), 30 (monthly)
sstringNoSegment definitions as JSON array
gstringNoProperty to group by

Search Users Parameters:
ParameterTypeRequiredDefaultDescription
userstringYesUser ID, device ID, or Amplitude ID to search for