Amplitude

Usage Instructions

Integrate Amplitude into your workflow to track events, identify users and groups, search for users, query analytics, and retrieve revenue data.

Tools

`amplitude_send_event`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`userId`	string	No	No description
`deviceId`	string	No	No description
`eventType`	string	Yes	Name of the event (e.g., "page_view", "purchase")
`eventProperties`	string	No	No description
`userProperties`	string	No	JSON object of user properties to set (supports $set, $setOnce, $add, $append, $unset)
`time`	string	No	No description
`sessionId`	string	No	No description
`insertId`	string	No	No description
`appVersion`	string	No	No description
`platform`	string	No	Platform (e.g., "Web", "iOS", "Android")
`country`	string	No	No description
`language`	string	No	Language code (e.g., "en")
`ip`	string	No	No description
`price`	string	No	No description
`quantity`	string	No	No description
`revenue`	string	No	No description
`productId`	string	No	No description
`revenueType`	string	No	Revenue type (e.g., "purchase", "refund")

Output

Parameter	Type	Description
`code`	number	Response code (200 for success)
`eventsIngested`	number	Number of events ingested
`payloadSizeBytes`	number	Size of the payload in bytes
`serverUploadTime`	number	Server upload timestamp

`amplitude_identify_user`

Set user properties in Amplitude using the Identify API. Supports $set, $setOnce, $add, $append, $unset operations.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`userId`	string	No	No description
`deviceId`	string	No	No description
`userProperties`	string	Yes	JSON object of user properties. Use operations like $set, $setOnce, $add, $append, $unset.

Output

Parameter	Type	Description
`code`	number	HTTP response status code
`message`	string	Response message

`amplitude_group_identify`

Set group-level properties in Amplitude. Supports $set, $setOnce, $add, $append, $unset operations.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`groupType`	string	Yes	Group classification (e.g., "company", "org_id")
`groupValue`	string	Yes	Specific group identifier (e.g., "Acme Corp")
`groupProperties`	string	Yes	JSON object of group properties. Use operations like $set, $setOnce, $add, $append, $unset.

Output

Parameter	Type	Description
`code`	number	HTTP response status code
`message`	string	Response message

`amplitude_user_search`

Search for a user by User ID, Device ID, or Amplitude ID using the Dashboard REST API.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description
`user`	string	Yes	No description

Output

Parameter	Type	Description
`matches`	array	List of matching users
↳ `amplitudeId`	number	Amplitude internal user ID
↳ `userId`	string	External user ID
`type`	string	Match type (e.g., match_user_or_device_id)

`amplitude_user_activity`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description
`amplitudeId`	string	Yes	No description
`offset`	string	No	No description
`limit`	string	No	No description
`direction`	string	No	Sort direction: "latest" or "earliest" (default: latest)

Output

Parameter	Type	Description
`events`	array	List of user events
↳ `eventType`	string	Type of event
↳ `eventTime`	string	Event timestamp
↳ `eventProperties`	json	Custom event properties
↳ `userProperties`	json	User properties at event time
↳ `sessionId`	number	Session ID
↳ `platform`	string	Platform
↳ `country`	string	Country
↳ `city`	string	City
`userData`	json	User metadata
↳ `userId`	string	External user ID
↳ `canonicalAmplitudeId`	number	Canonical Amplitude ID
↳ `numEvents`	number	Total event count
↳ `numSessions`	number	Total session count
↳ `platform`	string	Primary platform
↳ `country`	string	Country

`amplitude_user_profile`

Get a user profile including properties, cohort memberships, and computed properties.

Input

Parameter	Type	Required	Description
`secretKey`	string	Yes	No description
`userId`	string	No	No description
`deviceId`	string	No	No description
`getAmpProps`	string	No	No description
`getCohortIds`	string	No	No description
`getComputations`	string	No	No description

Output

Parameter	Type	Description
`userId`	string	External user ID
`deviceId`	string	Device ID
`ampProps`	json	Amplitude user properties (library, first_used, last_used, custom properties)
`cohortIds`	array	List of cohort IDs the user belongs to
`computations`	json	Computed user properties

`amplitude_event_segmentation`

Query event analytics data with segmentation. Get event counts, uniques, averages, and more.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description
`eventType`	string	Yes	No description
`start`	string	Yes	No description
`end`	string	Yes	No description
`metric`	string	No	Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula (default: uniques)
`interval`	string	No	No description
`groupBy`	string	No	Property name to group by (prefix custom user properties with "gp:")
`limit`	string	No	No description

Output

Parameter	Type	Description
`series`	json	Time-series data arrays indexed by series
`seriesLabels`	array	Labels for each data series
`seriesCollapsed`	json	Collapsed aggregate totals per series
`xValues`	array	Date values for the x-axis

`amplitude_get_active_users`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description
`start`	string	Yes	No description
`end`	string	Yes	No description
`metric`	string	No	Metric type: "active" or "new" (default: active)
`interval`	string	No	No description

Output

Parameter	Type	Description
`series`	json	Array of data series with user counts per time interval
`seriesMeta`	array	Metadata labels for each data series (e.g., segment names)
`xValues`	array	Date values for the x-axis

`amplitude_realtime_active_users`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description

Output

Parameter	Type	Description
`series`	json	Array of data series with active user counts at 5-minute intervals
`seriesLabels`	array	Labels for each series (e.g., "Today", "Yesterday")
`xValues`	array	Time values for the x-axis (e.g., "15:00", "15:05")

`amplitude_list_events`

List all event types in the Amplitude project with their weekly totals and unique counts.

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description

Output

Parameter	Type	Description
`events`	array	List of event types in the project
↳ `value`	string	Event type name
↳ `displayName`	string	Event display name
↳ `totals`	number	Weekly total count
↳ `hidden`	boolean	Whether the event is hidden
↳ `deleted`	boolean	Whether the event is deleted

`amplitude_get_revenue`

Input

Parameter	Type	Required	Description
`apiKey`	string	Yes	No description
`secretKey`	string	Yes	No description
`start`	string	Yes	No description
`end`	string	Yes	No description
`metric`	string	No	No description
`interval`	string	No	No description

Output

Parameter	Type	Description
`series`	json	Array of revenue data series
`seriesLabels`	array	Labels for each data series
`xValues`	array	Date values for the x-axis

Amplitude

On this page