Amplitude

Track events and query analytics from Amplitude

Amplitude is a leading digital analytics platform that helps teams understand user behavior, measure product performance, and make data-driven decisions at scale.

The Amplitude integration in Sim connects with the Amplitude HTTP and Dashboard REST APIs using API key and secret key authentication, allowing your agents to track events, manage user properties, and query analytics data programmatically. This API-based approach ensures secure access to Amplitude's full suite of analytics capabilities.

With the Amplitude integration, your agents can:

  • Track events: Send custom events to Amplitude with rich properties, revenue data, and user context directly from your workflows
  • Identify users: Set and update user properties using operations like $set, $setOnce, $add, $append, and $unset to maintain detailed user profiles
  • Search for users: Look up users by User ID, Device ID, or Amplitude ID to retrieve profile information and metadata
  • Query event analytics: Run event segmentation queries with grouping, custom metrics (uniques, totals, averages, DAU percentages), and flexible date ranges
  • Monitor user activity: Retrieve event streams for specific users to understand individual user journeys and behavior patterns
  • Analyze active users: Get active or new user counts over time with daily, weekly, or monthly granularity
  • Track revenue: Access revenue LTV metrics including ARPU, ARPPU, total revenue, and paying user counts

In Sim, the Amplitude integration enables powerful analytics automation scenarios. Your agents can track product events in real time based on workflow triggers, enrich user profiles as new data becomes available, query segmentation data to inform downstream decisions, or build monitoring workflows that alert on changes in key metrics. By connecting Sim with Amplitude, you can build intelligent agents that bridge the gap between analytics insights and automated action, enabling data-driven workflows that respond to user behavior patterns and product performance trends.

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

Track an event in Amplitude using the HTTP V2 API.

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
userIdstringNoUser ID (required if no device_id)
deviceIdstringNoDevice ID (required if no user_id)
eventTypestringYesName of the event (e.g., "page_view", "purchase")
eventPropertiesstringNoJSON object of custom event properties
userPropertiesstringNoJSON object of user properties to set (supports $set, $setOnce, $add, $append, $unset)
timestringNoEvent timestamp in milliseconds since epoch
sessionIdstringNoSession start time in milliseconds since epoch
insertIdstringNoUnique ID for deduplication (within 7-day window)
appVersionstringNoApplication version string
platformstringNoPlatform (e.g., "Web", "iOS", "Android")
countrystringNoTwo-letter country code
languagestringNoLanguage code (e.g., "en")
ipstringNoIP address for geo-location
pricestringNoPrice of the item purchased
quantitystringNoQuantity of items purchased
revenuestringNoRevenue amount
productIdstringNoProduct identifier
revenueTypestringNoRevenue type (e.g., "purchase", "refund")

Output

ParameterTypeDescription
codenumberResponse code (200 for success)
eventsIngestednumberNumber of events ingested
payloadSizeBytesnumberSize of the payload in bytes
serverUploadTimenumberServer upload timestamp

amplitude_identify_user

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

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
userIdstringNoUser ID (required if no device_id)
deviceIdstringNoDevice ID (required if no user_id)
userPropertiesstringYesJSON object of user properties. Use operations like $set, $setOnce, $add, $append, $unset.

Output

ParameterTypeDescription
codenumberHTTP response status code
messagestringResponse message

amplitude_group_identify

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

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
groupTypestringYesGroup classification (e.g., "company", "org_id")
groupValuestringYesSpecific group identifier (e.g., "Acme Corp")
groupPropertiesstringYesJSON object of group properties. Use operations like $set, $setOnce, $add, $append, $unset.

Output

ParameterTypeDescription
codenumberHTTP response status code
messagestringResponse message

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

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key
userstringYesUser ID, Device ID, or Amplitude ID to search for

Output

ParameterTypeDescription
matchesarrayList of matching users
amplitudeIdnumberAmplitude internal user ID
userIdstringExternal user ID
typestringMatch type (e.g., match_user_or_device_id)

amplitude_user_activity

Get the event stream for a specific user by their Amplitude ID.

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key
amplitudeIdstringYesAmplitude internal user ID
offsetstringNoOffset for pagination (default 0)
limitstringNoMaximum number of events to return (default 1000, max 1000)
directionstringNoSort direction: "latest" or "earliest" (default: latest)

Output

ParameterTypeDescription
eventsarrayList of user events
eventTypestringType of event
eventTimestringEvent timestamp
eventPropertiesjsonCustom event properties
userPropertiesjsonUser properties at event time
sessionIdnumberSession ID
platformstringPlatform
countrystringCountry
citystringCity
userDatajsonUser metadata
userIdstringExternal user ID
canonicalAmplitudeIdnumberCanonical Amplitude ID
numEventsnumberTotal event count
numSessionsnumberTotal session count
platformstringPrimary platform
countrystringCountry

amplitude_user_profile

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

Input

ParameterTypeRequiredDescription
secretKeystringYesAmplitude Secret Key
userIdstringNoExternal user ID (required if no device_id)
deviceIdstringNoDevice ID (required if no user_id)
getAmpPropsstringNoInclude Amplitude user properties (true/false, default: false)
getCohortIdsstringNoInclude cohort IDs the user belongs to (true/false, default: false)
getComputationsstringNoInclude computed user properties (true/false, default: false)

Output

ParameterTypeDescription
userIdstringExternal user ID
deviceIdstringDevice ID
ampPropsjsonAmplitude user properties (library, first_used, last_used, custom properties)
cohortIdsarrayList of cohort IDs the user belongs to
computationsjsonComputed user properties

amplitude_event_segmentation

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

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key
eventTypestringYesEvent type name to analyze
startstringYesStart date in YYYYMMDD format
endstringYesEnd date in YYYYMMDD format
metricstringNoMetric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula (default: uniques)
intervalstringNoTime interval: 1 (daily), 7 (weekly), or 30 (monthly)
groupBystringNoProperty name to group by (prefix custom user properties with "gp:")
limitstringNoMaximum number of group-by values (max 1000)

Output

ParameterTypeDescription
seriesjsonTime-series data arrays indexed by series
seriesLabelsarrayLabels for each data series
seriesCollapsedjsonCollapsed aggregate totals per series
xValuesarrayDate values for the x-axis

amplitude_get_active_users

Get active or new user counts over a date range from the Dashboard REST API.

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key
startstringYesStart date in YYYYMMDD format
endstringYesEnd date in YYYYMMDD format
metricstringNoMetric type: "active" or "new" (default: active)
intervalstringNoTime interval: 1 (daily), 7 (weekly), or 30 (monthly)

Output

ParameterTypeDescription
seriesjsonArray of data series with user counts per time interval
seriesMetaarrayMetadata labels for each data series (e.g., segment names)
xValuesarrayDate values for the x-axis

amplitude_realtime_active_users

Get real-time active user counts at 5-minute granularity for the last 2 days.

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key

Output

ParameterTypeDescription
seriesjsonArray of data series with active user counts at 5-minute intervals
seriesLabelsarrayLabels for each series (e.g., "Today", "Yesterday")
xValuesarrayTime 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

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key

Output

ParameterTypeDescription
eventsarrayList of event types in the project
valuestringEvent type name
displayNamestringEvent display name
totalsnumberWeekly total count
hiddenbooleanWhether the event is hidden
deletedbooleanWhether the event is deleted

amplitude_get_revenue

Get revenue LTV data including ARPU, ARPPU, total revenue, and paying user counts.

Input

ParameterTypeRequiredDescription
apiKeystringYesAmplitude API Key
secretKeystringYesAmplitude Secret Key
startstringYesStart date in YYYYMMDD format
endstringYesEnd date in YYYYMMDD format
metricstringNoMetric: 0 (ARPU), 1 (ARPPU), 2 (Total Revenue), 3 (Paying Users)
intervalstringNoTime interval: 1 (daily), 7 (weekly), or 30 (monthly)

Output

ParameterTypeDescription
seriesjsonArray of revenue data series
seriesLabelsarrayLabels for each data series
xValuesarrayDate values for the x-axis

On this page

Start building today
Trusted by over 70,000 builders.
Build Agentic workflows visually on a drag-and-drop canvas or with natural language.
Get started