Amplitude

使用说明

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

工具

`amplitude_send_event`

Track an event in Amplitude using the HTTP V2 API.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`userId`	string	否	User ID (required if no device_id)
`deviceId`	string	否	Device ID (required if no user_id)
`eventType`	string	是	Name of the event (e.g., "page_view", "purchase")
`eventProperties`	string	否	JSON object of custom event properties
`userProperties`	string	否	JSON object of user properties to set (supports $set, $setOnce, $add, $append, $unset)
`time`	string	否	Event timestamp in milliseconds since epoch
`sessionId`	string	否	Session start time in milliseconds since epoch
`insertId`	string	否	Unique ID for deduplication (within 7-day window)
`appVersion`	string	否	Application version string
`platform`	string	否	Platform (e.g., "Web", "iOS", "Android")
`country`	string	否	Two-letter country code
`language`	string	否	Language code (e.g., "en")
`ip`	string	否	IP address for geo-location
`price`	string	否	Price of the item purchased
`quantity`	string	否	Quantity of items purchased
`revenue`	string	否	Revenue amount
`productId`	string	否	Product identifier
`revenueType`	string	否	Revenue type (e.g., "purchase", "refund")

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`userId`	string	否	User ID (required if no device_id)
`deviceId`	string	否	Device ID (required if no user_id)
`userProperties`	string	是	JSON object of user properties. Use operations like $set, $setOnce, $add, $append, $unset.

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`groupType`	string	是	Group classification (e.g., "company", "org_id")
`groupValue`	string	是	Specific group identifier (e.g., "Acme Corp")
`groupProperties`	string	是	JSON object of group properties. Use operations like $set, $setOnce, $add, $append, $unset.

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key
`user`	string	是	User ID, Device ID, or Amplitude ID to search for

输出

参数	类型	描述
`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`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key
`amplitudeId`	string	是	Amplitude internal user ID
`offset`	string	否	Offset for pagination (default 0)
`limit`	string	否	Maximum number of events to return (default 1000, max 1000)
`direction`	string	否	Sort direction: "latest" or "earliest" (default: latest)

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`secretKey`	string	是	Amplitude Secret Key
`userId`	string	否	External user ID (required if no device_id)
`deviceId`	string	否	Device ID (required if no user_id)
`getAmpProps`	string	否	Include Amplitude user properties (true/false, default: false)
`getCohortIds`	string	否	Include cohort IDs the user belongs to (true/false, default: false)
`getComputations`	string	否	Include computed user properties (true/false, default: false)

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key
`eventType`	string	是	Event type name to analyze
`start`	string	是	Start date in YYYYMMDD format
`end`	string	是	End date in YYYYMMDD format
`metric`	string	否	Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula (default: uniques)
`interval`	string	否	Time interval: 1 (daily), 7 (weekly), or 30 (monthly)
`groupBy`	string	否	Property name to group by (prefix custom user properties with "gp:")
`limit`	string	否	Maximum number of group-by values (max 1000)

输出

参数	类型	描述
`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`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key
`start`	string	是	Start date in YYYYMMDD format
`end`	string	是	End date in YYYYMMDD format
`metric`	string	否	Metric type: "active" or "new" (default: active)
`interval`	string	否	Time interval: 1 (daily), 7 (weekly), or 30 (monthly)

输出

参数	类型	描述
`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`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key

输出

参数	类型	描述
`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.

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key

输出

参数	类型	描述
`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`

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

输入

参数	类型	必填	描述
`apiKey`	string	是	Amplitude API Key
`secretKey`	string	是	Amplitude Secret Key
`start`	string	是	Start date in YYYYMMDD format
`end`	string	是	End date in YYYYMMDD format
`metric`	string	否	Metric: 0 (ARPU), 1 (ARPPU), 2 (Total Revenue), 3 (Paying Users)
`interval`	string	否	Time interval: 1 (daily), 7 (weekly), or 30 (monthly)

输出

参数	类型	描述
`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