← Tools Reference

Amplitude

Amplitude integration (Data). Imported from open-connector.

API key4 toolshttps://amplitude.com
GET
amplitude_list_events
List visible Amplitude events with current-week totals and display metadata.

/api/2/events/list

1 parameter
ParamTypeRequiredDescription
dataResidencystringoptionalThe Amplitude data residency region.
GET
amplitude_get_event_segmentation
Get Amplitude event segmentation metrics for one or two event queries.

/api/2/events/segmentation

15 parameters
ParamTypeRequiredDescription
eventobjectrequiredAn Amplitude event query object.
secondEventobjectoptionalAn Amplitude event query object.
startstringrequiredA date formatted as YYYYMMDD.
endstringrequiredA date formatted as YYYYMMDD.
metricstringoptionalThe Amplitude segmentation metric.
userTypestringoptionalThe Amplitude user type filter.
intervalintegeroptionalThe Amplitude interval value, such as 1, 7, or 30.
segmentsarrayoptionalAmplitude segment definitions.
groupBystringoptionalThe Amplitude property name to group by.
secondGroupBystringoptionalThe second Amplitude property name to group by.
limitintegeroptionalThe maximum number of group-by values to return.
formulastringoptionalThe Amplitude custom formula expression.
rollingWindowintegeroptionalThe rolling window size.
rollingAverageintegeroptionalThe rolling average size.
dataResidencystringoptionalThe Amplitude data residency region.
GET
amplitude_search_user
Search for an Amplitude user by Amplitude ID, device ID, user ID, or prefix.

/api/2/usersearch

2 parameters
ParamTypeRequiredDescription
userstringrequiredThe Amplitude ID, device ID, user ID, or user ID prefix to search.
dataResidencystringoptionalThe Amplitude data residency region.
GET
amplitude_get_user_activity
Get an Amplitude user summary and recent or earliest activity events.

/api/2/useractivity

5 parameters
ParamTypeRequiredDescription
userstringrequiredThe Amplitude ID of the user.
offsetintegeroptionalThe zero-indexed offset from the most recent event.
limitintegeroptionalThe number of events to return.
directionstringoptionalThe event direction to return.
dataResidencystringoptionalThe Amplitude data residency region.