Skip to main content
Amplitude logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 54
  • Triggers: 0
  • Slug: AMPLITUDE
  • Version: 20261101_00

Tools

Slug: AMPLITUDE_ASSIGN_ANNOTATIONS_TO_CATEGORYTool to bulk assign multiple annotations to a category in Amplitude. Use when you need to organize annotations by assigning them to a specific category.

Input Parameters

integer
required
Category ID to assign annotations to
array
required
Array of annotation IDs to assign to the category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CANCEL_DELETIONCancel a pending user deletion request in Amplitude. Use this to remove a user from a scheduled deletion job before it completes. Only works on deletion jobs in ‘Staging’ status (not yet submitted).

Input Parameters

string
required
The Amplitude ID to remove from the deletion job. This is the unique identifier for the user whose deletion request you want to cancel.
string
required
The scheduled deletion date in YYYY-MM-DD format. This is the date when the deletion job is scheduled to begin. Must match the exact date from the original deletion request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CHECK_COHORT_STATUSCheck the status of a cohort export request. This action allows you to: - Poll the status of an in-progress cohort download request - Determine if a cohort is ready for download

Input Parameters

string
required
Request ID from cohort request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CREATE_ANNOTATIONCreate a chart annotation in Amplitude to mark important dates. Use to highlight key events like feature releases, marketing campaigns, or product updates on analytics charts.

Input Parameters

string
End date/time in ISO 8601 format for time ranges. Omit for single-point annotations.
string
required
The title of the annotation
string
required
Start date/time in ISO 8601 format (e.g., ‘2025-11-01T07:00:00+00:00’)
string
Additional details or description for the annotation
string
Category name to organize the annotation (e.g., ‘Releases’, ‘Marketing’). Must be an existing category.
string
Specific chart ID to associate the annotation with. Omit to create a global annotation visible across all charts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CREATE_ANNOTATION_CATEGORYTool to create an annotation category in Amplitude to organize annotations. Use when you need to create a new category for grouping related annotations.

Input Parameters

string
required
The name of the annotation category to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CREATE_EVENT_CATEGORYCreate a new event category in Amplitude. This action allows you to: - Create a new event category to organize event types - Validate category name before creation Key features: - Creates event categories for organizing events - Returns success/failure status

Input Parameters

string
required
Name of the category to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CREATE_EVENT_TYPECreate a new event type in Amplitude. This action allows you to: - Define a new event type with various properties - Associate the event with a category - Add metadata like description, tags, and owner Key features: - Creates trackable events in your Amplitude project - Supports full event type configuration

Input Parameters

string
List of tags, separated by a comma
string
Owner of the event type
string
The event type’s category
boolean
Activity of the event type
string
required
The event name
string
Details about the event type
boolean
Event type is hidden from timeline
boolean
Event type is hidden from dropdowns
boolean
Event type is hidden from pathfinder
boolean
Event type is hidden from persona results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_CREATE_RELEASECreate a release to document product changes. Use when you want to track app version releases and their impact on metrics. Can be integrated into deployment workflows to automatically log releases in Amplitude.

Input Parameters

string
Title of the release for easy identification
string
required
Version string for the release (e.g., ‘1.0.0’, ‘2.1.3’)
array
Array of platforms this release applies to (e.g., [‘iOS’, ‘Android’, ‘Web’])
string
Description of what changed in this release. Include key features, bug fixes, or improvements.
string
required
Release start date/time in format ‘YYYY-MM-DD HH:MM:SS’ (e.g., ‘2026-02-12 00:00:00’). This marks when the release became active.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DELETE_ANNOTATIONDelete a chart annotation from Amplitude. Use to remove existing annotations from charts.

Input Parameters

string
required
Annotation ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DELETE_ANNOTATION_CATEGORYDelete an Amplitude annotation category by ID.

Input Parameters

integer
required
The ID of the annotation category to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DELETE_EVENT_CATEGORYDelete an event category from Amplitude. This action allows you to: - Delete an existing event category - Remove category organization from events Key features: - Permanently removes event categories - Returns success/failure status

Input Parameters

integer
required
ID of the category to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DELETE_EVENT_TYPEDelete an event type from Amplitude. This action allows you to: - Remove an event type from your project - Mark live events as deleted - Remove planned events from the tracking plan Key features: - Different behavior based on event status (live, planned, etc.) - Returns success/failure status

Input Parameters

string
required
The event name to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DELETE_USERSSubmit Amplitude user deletion requests by Amplitude IDs or user IDs, with up to 100 IDs per list and an option to target the entire organization. When the API returns a list of deletion details, only the first detail is returned.

Input Parameters

array
Array of string User IDs to delete (e.g., [‘user_1’, ‘user_2’]). Either amplitude_ids or user_ids must be provided. Maximum 100 users per request.
string
required
Email address of the person requesting deletion (for auditing). Must be a valid email format.
array
Array of numeric Amplitude IDs to delete (e.g., [123456, 789012]). Either amplitude_ids or user_ids must be provided. Maximum 100 users per request.
boolean
If true, deletes from entire organization instead of single project. Default false.
string
Must be string ‘True’ or ‘False’ (capitalized). When ‘True’, API returns 200 even if IDs don’t exist. When ‘False’ (default), returns 400 for invalid IDs.
boolean
If true, returns valid user_id values corresponding to supplied amplitude_ids in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_DOWNLOAD_COHORT_FILEDownload the cohort file after request is complete. Use this action after checking that the cohort status is ‘JOB COMPLETED’. The download link is valid for 7 days, but the S3 link is valid for only 1 minute.

Input Parameters

string
required
Request ID from cohort download request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_FIND_USERSearch for users in Amplitude by canonical identifier (Amplitude ID, device ID, user ID, or user ID prefix). Use this to find matching Amplitude IDs for deterministic user mapping. Important: This searches only canonical identifiers (Amplitude ID, device_id, user_id), NOT arbitrary user properties like email unless email is your actual user_id.

Input Parameters

string
required
The user identifier to search for. This must be one of: Amplitude ID, Device ID, User ID, or User ID prefix. This searches canonical identifiers (Amplitude ID, device_id, user_id) - NOT arbitrary user properties like email unless email is actually the user_id in your Amplitude project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_ACTIVE_USERSGet the number of active or new users for a date range with optional segmentation. Use when you need user count metrics aggregated by day, week, or month, optionally grouped by user properties.

Input Parameters

string
Group by property name for segmentation (e.g., ‘city’, ‘country’, ‘device_type’)
integer ("1" | "7" | "30")
Interval type for aggregation
string ("active" | "new")
Metric type for user counts
string
JSON array string of segment filters to apply to the query
string
required
End date in YYYYMMDD format (e.g., ‘20260212’)
string
required
Start date in YYYYMMDD format (e.g., ‘20260205’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_ANNOTATIONGet an Amplitude chart annotation by ID, including its label, timestamps, category, and associated chart.

Input Parameters

string
required
The ID of the annotation to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_ANNOTATION_CATEGORYGet the details of an Amplitude annotation category by ID.

Input Parameters

string
required
Category ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_COHORTRequest an Amplitude cohort export by ID, optionally including selected user properties. The request returns an ID for polling status and downloading the export.

Input Parameters

string
required
Cohort ID to retrieve
array
User properties to include
boolean
Include user properties in response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_DELETION_REQUESTSGet the status of user deletion requests within a date range. Use this to track GDPR/CCPA deletion compliance and monitor deletion job progress.

Input Parameters

string
required
End date for deletion requests in YYYY-MM-DD format
string
required
Start date for deletion requests in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_EVENT_CATEGORIESGet event categories from Amplitude. This action allows you to: - Get all event categories in your project - Get a specific category by name

Input Parameters

string
Optional category name to get specific category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_EVENT_PROPERTYGet a specific event property from Amplitude taxonomy. Use when you need to retrieve details about a specific event property including its type, validation rules, and metadata.

Input Parameters

string
required
The event property name to retrieve
string
The event type associated with the property. Optional but recommended to get event-specific property details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_EVENT_SEGMENTATIONRequest Amplitude event segmentation data to analyze event metrics over time, optionally grouped by property. Choose unique users, totals, percentage of daily active users, or averages, with realtime, hourly, daily, or weekly intervals.

Input Parameters

string
required
JSON-encoded event definition. Example: {“event_type”:“page_view”} or {“event_type”:“purchase”,“filters”:[{“subprop_type”:“event”,“subprop_key”:“price”,“subprop_op”:“greater”,“subprop_value”:[“10”]}]}
string
Property to group results by. Use event property names like ‘country’, ‘device_type’, etc.
string ("-300000" | "1" | "7" | "30")
Time interval for bucketing results: ‘-300000’ (realtime/5-min), ‘1’ (hourly), ‘7’ (daily), ‘30’ (weekly). Default is ‘1’.
string ("uniques" | "totals" | "pct_dau" | "average")
Metric type to calculate. Default is ‘uniques’.
string
required
End date for the query in YYYYMMDD format
string
required
Start date for the query in YYYYMMDD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_EVENT_TYPEGet an Amplitude event type by exact name, returning selected details such as category, description, settings, tags and owner.

Input Parameters

string
required
The event name to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_EVENT_TYPESGet all event types from Amplitude. This action allows you to: - Retrieve all event types in your project - Optionally include deleted events

Input Parameters

boolean
Whether to include deleted events

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_FUNNEL_DATAGet funnel analysis data showing user conversion through a sequence of events. Use this to analyze user drop-off rates and conversion times across multiple steps in a user journey.

Input Parameters

string
Group by property name. For custom properties, prepend with ‘gp:’ (e.g., ‘gp:country’). Only one group-by property is allowed.
integer ("-300000" | "-3600000" | "1" | "7" | "30")
Interval options for funnel analysis
string ("new" | "active")
User type options for funnel analysis
integer
Conversion window in seconds (how long users have to complete the funnel). Defaults to 2,592,000 seconds (30 days).
string
required
End date in YYYYMMDD format (e.g., ‘20260212’)
string ("ordered" | "unordered" | "sequential")
Funnel mode options
integer
Number of group-by values to return. Must be between 1 and 1000. Defaults to 100.
string
required
Start date in YYYYMMDD format (e.g., ‘20260201’)
array
required
List of events representing funnel steps (2-4 events required). Each event represents a step in the user journey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_REALTIME_ACTIVE_USERSGet real-time active users count from Amplitude. Returns active user counts with 5-minute granularity (configurable) for today and yesterday. Use this to monitor current user activity and compare with historical data.

Input Parameters

integer
Time interval in minutes. The Amplitude realtime endpoint only supports 5-minute intervals. This parameter can be omitted or set to 5. Other values will result in a 400 Bad Request error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_RETENTIONGet user retention analysis showing how users return over time after a starting action. Use when analyzing user engagement patterns, measuring feature stickiness, or understanding long-term user behavior across cohorts.

Input Parameters

string
Property to group by (limit of one). Use ‘gp:’ prefix for custom properties (e.g., ‘gp:plan_type’)
integer ("1" | "7" | "30")
Interval options in days
string
JSON-encoded segment definitions for filtering (optional)
string
Retention bracket ranges, required if rm=bracket. Format: “[[0,4],[5,9]]” for day ranges
string
required
JSON-encoded return event object (e.g., ’{“event_type”:“_active”}’ for active users or ’{“event_type”:“_all”}’ for all events)
string ("bracket" | "rolling" | "n-day")
Retention mode options
string
required
JSON-encoded starting event object (e.g., ’{“event_type”:“_active”}’ for active users or ’{“event_type”:“_new”}’ for new users)
string
required
End date in YYYYMMDD format
string
required
Start date in YYYYMMDD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_REVENUE_LTVGet revenue lifetime value (LTV) metrics including ARPU, ARPPU, and total revenue. Use when you need to analyze revenue trends over time for user cohorts.

Input Parameters

integer ("1" | "7" | "30")
Interval type for revenue LTV aggregation
integer ("0" | "1" | "2" | "3")
Metric type for revenue LTV calculation
string
required
End date in YYYYMMDD format (e.g., 20260212)
string
required
Start date in YYYYMMDD format (e.g., 20260101)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_SESSION_AVERAGEGet average session length (in seconds) for a specified date range from Amplitude. Use when you need to analyze user engagement patterns and session duration trends over time.

Input Parameters

string
required
End date in YYYYMMDD format (e.g., ‘20260212’ for February 12, 2026)
string
required
Start date in YYYYMMDD format (e.g., ‘20260113’ for January 13, 2026)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_SESSION_LENGTHTool to retrieve session length distribution data for a specified date range from Amplitude. Use when you need to analyze how long users’ sessions typically last or visualize session duration patterns across time buckets.

Input Parameters

string
required
End date in YYYYMMDD format (e.g., ‘20260212’)
string
required
Start date in YYYYMMDD format (e.g., ‘20260205’)
integer
Maximum value for bucketing (e.g., 600). Must be used with binMin and binSize for custom bucketing.
integer
Minimum value for bucketing (e.g., 0). Must be used with binMax and binSize for custom bucketing.
integer
Size of each bucket (e.g., 60 for 60-second buckets). Must be used with binMin and binMax for custom bucketing.
string
Time unit for bucket sizes: ‘hours’, ‘minutes’, or ‘seconds’. If not specified, uses default bucketing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_SESSIONS_PER_USERTool to get average number of sessions per user for each day in a date range from Amplitude. Use when analyzing user engagement patterns or session frequency over time.

Input Parameters

string
required
End date in YYYYMMDD format (e.g., ‘20260212’)
string
required
Start date in YYYYMMDD format (e.g., ‘20260205’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_USER_ACTIVITYFetch a single user’s profile summary and event stream by Amplitude ID. Use when you need to extract attribution data (UTM parameters, referrers) from early events or user properties, or when analyzing user behavior patterns.

Input Parameters

string
required
Amplitude ID of the user to retrieve activity for
integer
Number of events to return (1-1000). Default is 100 to avoid large payloads. Note: session boundary behavior may affect actual count returned.
integer
Zero-indexed offset from most recent event (default: 0)
string ("earliest" | "latest")
Direction to retrieve events: ‘earliest’ for oldest first, ‘latest’ for newest first (default)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_USER_COMPOSITIONTool to get user composition breakdown by property (platform, version, country, etc.). Use when analyzing user distribution across property values during a date range.

Input Parameters

string
required
Property to segment by. Built-in options: ‘version’, ‘country’, ‘city’, ‘region’, ‘DMA’, ‘language’, ‘platform’, ‘os’, ‘device’, ‘start_version’, ‘paying’. Custom user properties use format ‘gp:name’
string
required
End date in YYYYMMDD format (e.g., ‘20250212’)
string
required
Start date in YYYYMMDD format (e.g., ‘20250211’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_USER_MAPPINGSGet the list of user mappings for provided user IDs. Use when you need to retrieve aliasing relationships between user identifiers in Amplitude. Returns mapping data showing which users map into and out of the requested user IDs.

Input Parameters

array
required
Array of user IDs to get mappings for. Returns the list of mappings that involve the provided user IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_GET_USER_PROPERTYGet a specific user property from Amplitude taxonomy. Use when you need to retrieve details about a specific user property including its type, validation rules, and classifications.

Input Parameters

string
required
The user property name to retrieve. Custom properties have a ‘gp:’ prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_IDENTIFYUpdate user properties using Amplitude’s Identify API. This action allows you to: - Set or update the User ID for a Device ID - Update user properties without sending an event - Perform operations on user properties (set, append, etc.) - Update user attributes like device info and location

Input Parameters

string
Your Amplitude API Key for your project. If not provided, will be extracted from authentication credentials.
string
required
Single identification object or array of identifications

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_ANNOTATION_CATEGORIESList all annotation categories from Amplitude. Use to retrieve available categories for chart annotations.

Input Parameters

string
When specified, returns only that particular category. Otherwise returns all categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_ANNOTATIONSTool to get all chart annotations with optional filtering by category, chart, and date range. Use when you need to retrieve annotations that mark important events or milestones on Amplitude charts.

Input Parameters

string
Filter annotations before this ISO 8601 timestamp
string
Filter annotations occurring after this ISO 8601 timestamp
string
Filter by category name (mutually exclusive with chart_id)
string
Filter by chart ID (mutually exclusive with category)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_COHORTSList all discoverable cohorts for an Amplitude project. This action allows you to: - Get a list of all cohorts in your Amplitude project - Optionally include sync information for each cohort Key features: - Returns cohort details including ID, name, size, and definition - Optionally includes sync metadata for integration with other tools - Supports EU data residency. An empty result may indicate insufficient permissions to view cohorts rather than an absence of cohorts in the project.

Input Parameters

boolean
Whether to include cohort sync metadata

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_EVENT_PROPERTIESGet all event properties from Amplitude, optionally filtered by event type or property name. Use when you need to retrieve property definitions, data types, or validation rules for events.

Input Parameters

string
Filter by event type name. If provided, returns only properties for this specific event type
string
Filter by property name. If provided, returns only properties matching this name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_EVENTSList event types in an Amplitude project with current-week occurrence totals and event visibility and deletion status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_LIST_USER_PROPERTIESTool to get all user properties in your Amplitude project. Use when you need to retrieve the complete list of user properties including both default and custom properties.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_MAP_USERMap users with different user IDs together (alias/merge users) in Amplitude. Use this to merge user identities across different identifiers or unmap previously merged users. Supports up to 2000 mappings per request with 1MB size limit.

Input Parameters

string
Your Amplitude API Key for any project in your organization. If not provided, will be extracted from authentication credentials
string
required
Single mapping object or array of mapping objects to map user IDs together. Can map up to 2000 users per request with 1MB size limit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_RESTORE_EVENT_TYPERestore a deleted event type in Amplitude. This action allows you to: - Restore a previously deleted event type - Make the event available again in the UI and API Key features: - Undoes the deletion of an event type - Returns success/failure status

Input Parameters

string
required
The event name to restore

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_SEND_EVENTSSend events to Amplitude using the HTTP V2 API for user behavior tracking and analytics. The action validates event types and identifiers before uploading.

Input Parameters

array
required
Array of events to upload
string
Your Amplitude API Key for your project. If not provided, will be extracted from the authentication metadata.
object
Model for Amplitude API options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_SET_GROUP_PROPERTIESSet group properties for account-level reporting without sending an event. Use this action to update group attributes like company name, industry, or plan type. Requires Enterprise plan with Accounts add-on.

Input Parameters

string
Your Amplitude API Key for your project. If not provided, will be extracted from authentication credentials.
string
required
Single group identification object or array of identifications (max 1024 per request)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPDATE_ANNOTATIONTool to update an existing chart annotation in Amplitude. Use when you need to modify annotation properties such as label, timestamps, category, or chart association. Supports partial updates - only include fields you want to change.

Input Parameters

string
Timestamp in ISO 8601 format for annotation end. Set to null to convert to a point-in-time annotation
string
The title of your annotation
string
Timestamp in ISO 8601 format for annotation start (e.g., ‘2026-02-13T00:00:00Z’)
string
Details for the annotation
string
The name of the category that the annotation belongs to
string
Chart identifier. Set to null to make annotation visible globally across all charts
string
required
The ID of the annotation to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPDATE_ANNOTATION_CATEGORYTool to update an annotation category in Amplitude. Use when you need to rename or modify an existing annotation category for organizing chart annotations.

Input Parameters

string
required
Updated name for the annotation category
string
required
ID of the annotation category to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPDATE_COHORT_MEMBERSHIPIncrementally update cohort membership by adding or removing IDs. This action allows you to: - Add new IDs to an existing cohort - Remove IDs from an existing cohort - Perform multiple operations in a single request

Input Parameters

string
required
Cohort ID to update
string
Count group of the IDs
array
required
Membership operations to perform
boolean
Skip invalid IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPDATE_EVENT_CATEGORYUpdate an existing event category in Amplitude. This action allows you to: - Update the name of an existing event category - Validate the new category name Key features: - Updates category names - Returns success/failure status

Input Parameters

integer
required
ID of the category to update
string
required
New name for the category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPDATE_EVENT_TYPEUpdate an existing event type in Amplitude. This action allows you to: - Change event type properties - Update event name, category, metadata, and settings - Modify display name for ingested events Key features: - Updates event type configuration - Supports partial updates (only specified fields are changed)

Input Parameters

string
List of tags, separated by a comma
string
Owner of the event type
string
Category name for the event type
boolean
Activity of the event type
string
required
The event name to update
string
Details about the event type
string
Display name of the event type
string
New name for the event type
boolean
Event type is hidden from timeline
boolean
Event type is hidden from dropdowns
boolean
Event type is hidden from pathfinder
boolean
Event type is hidden from persona results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPLOAD_BATCH_EVENTSBulk upload events to Amplitude using the Batch Event Upload API, with up to 2,000 events per request. Each event must include an event type and a user ID or device ID.

Input Parameters

array
required
Array of events to upload
string
Your Amplitude API Key for your project. If not provided, will be extracted from the authentication metadata.
object
Model for Amplitude API options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AMPLITUDE_UPLOAD_COHORTGenerate a new cohort or update an existing cohort by uploading user IDs or Amplitude IDs. Use when you need to create cohorts from a specific list of users.

Input Parameters

array
required
Array of user IDs or Amplitude IDs to include in the cohort
string
required
Name of the cohort
string
required
Email address of the cohort owner (must be a valid email)
integer
required
Project ID for the cohort
string ("BY_AMP_ID" | "BY_USER_ID")
required
Type of IDs being uploaded: BY_AMP_ID for Amplitude IDs or BY_USER_ID for user IDs
boolean
required
Whether the cohort is discoverable by other users in the project
string
ID of an existing cohort to update. If provided, the cohort will be updated instead of creating a new one

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not