# Amplitude

Amplitude gives you the self-serve tools and real-time data to make products and experiences that win no matter what.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 54
- **Triggers:** 0
- **Slug:** `AMPLITUDE`
- **Version:** 20260316_00

## Tools

### Bulk Assign Annotations to Category

**Slug:** `AMPLITUDE_ASSIGN_ANNOTATIONS_TO_CATEGORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | Category ID to assign annotations to |
| `annotation_ids` | array | Yes | Array of annotation IDs to assign to the category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel User Deletion

**Slug:** `AMPLITUDE_CANCEL_DELETION`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `amplitude_id` | string | Yes | The Amplitude ID to remove from the deletion job. This is the unique identifier for the user whose deletion request you want to cancel. |
| `job_start_day` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check Amplitude Cohort Status

**Slug:** `AMPLITUDE_CHECK_COHORT_STATUS`

Check 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Request ID from cohort request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Chart Annotation in Amplitude

**Slug:** `AMPLITUDE_CREATE_ANNOTATION`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | End date/time in ISO 8601 format for time ranges. Omit for single-point annotations. |
| `label` | string | Yes | The title of the annotation |
| `start` | string | Yes | Start date/time in ISO 8601 format (e.g., '2025-11-01T07:00:00+00:00') |
| `details` | string | No | Additional details or description for the annotation |
| `category` | string | No | Category name to organize the annotation (e.g., 'Releases', 'Marketing'). Must be an existing category. |
| `chart_id` | string | No | Specific chart ID to associate the annotation with. Omit to create a global annotation visible across all charts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Annotation Category

**Slug:** `AMPLITUDE_CREATE_ANNOTATION_CATEGORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | Yes | The name of the annotation category to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Amplitude Event Category

**Slug:** `AMPLITUDE_CREATE_EVENT_CATEGORY`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_name` | string | Yes | Name of the category to create |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Amplitude Event Type

**Slug:** `AMPLITUDE_CREATE_EVENT_TYPE`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | No | List of tags, separated by a comma |
| `owner` | string | No | Owner of the event type |
| `category` | string | No | The event type's category |
| `is_active` | boolean | No | Activity of the event type |
| `event_type` | string | Yes | The event name |
| `description` | string | No | Details about the event type |
| `is_hidden_from_timeline` | boolean | No | Event type is hidden from timeline |
| `is_hidden_from_dropdowns` | boolean | No | Event type is hidden from dropdowns |
| `is_hidden_from_pathfinder` | boolean | No | Event type is hidden from pathfinder |
| `is_hidden_from_persona_results` | boolean | No | Event type is hidden from persona results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Amplitude Release

**Slug:** `AMPLITUDE_CREATE_RELEASE`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Title of the release for easy identification |
| `version` | string | Yes | Version string for the release (e.g., '1.0.0', '2.1.3') |
| `platforms` | array | No | Array of platforms this release applies to (e.g., ['iOS', 'Android', 'Web']) |
| `description` | string | No | Description of what changed in this release. Include key features, bug fixes, or improvements. |
| `release_start` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Amplitude Chart Annotation

**Slug:** `AMPLITUDE_DELETE_ANNOTATION`

Delete a chart annotation from Amplitude. Use to remove existing annotations from charts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `annotation_id` | string | Yes | Annotation ID to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Amplitude Annotation Category

**Slug:** `AMPLITUDE_DELETE_ANNOTATION_CATEGORY`

Delete an annotation category from Amplitude. Use when you need to remove an annotation category that is no longer needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | The ID of the annotation category to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Amplitude Event Category

**Slug:** `AMPLITUDE_DELETE_EVENT_CATEGORY`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | ID of the category to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Amplitude Event Type

**Slug:** `AMPLITUDE_DELETE_EVENT_TYPE`

Delete 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | Yes | The event name to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Amplitude Users

**Slug:** `AMPLITUDE_DELETE_USERS`

Submit user deletion requests for GDPR/CCPA compliance. Supports up to 100 users per request. Use when you need to delete user data from Amplitude in compliance with privacy regulations. Either amplitude_ids or user_ids must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_ids` | array | No | 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. |
| `requester` | string | Yes | Email address of the person requesting deletion (for auditing). Must be a valid email format. |
| `amplitude_ids` | array | No | 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. |
| `delete_from_org` | boolean | No | If true, deletes from entire organization instead of single project. Default false. |
| `ignore_invalid_id` | string | No | 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. |
| `include_mapped_user_ids` | boolean | No | If true, returns valid user_id values corresponding to supplied amplitude_ids in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Amplitude Cohort File

**Slug:** `AMPLITUDE_DOWNLOAD_COHORT_FILE`

Download 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Request ID from cohort download request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Amplitude User

**Slug:** `AMPLITUDE_FIND_USER`

Search 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Active or New Users

**Slug:** `AMPLITUDE_GET_ACTIVE_USERS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `g` | string | No | Group by property name for segmentation (e.g., 'city', 'country', 'device_type') |
| `i` | integer ("1" | "7" | "30") | No | Interval type for aggregation |
| `m` | string ("active" | "new") | No | Metric type for user counts |
| `s` | string | No | JSON array string of segment filters to apply to the query |
| `end` | string | Yes | End date in YYYYMMDD format (e.g., '20260212') |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., '20260205') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Annotation

**Slug:** `AMPLITUDE_GET_ANNOTATION`

Get a single chart annotation by ID from Amplitude. Use when you need to retrieve detailed information about a specific annotation including its label, timestamps, category, and associated chart.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `annotation_id` | string | Yes | The ID of the annotation to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Annotation Category

**Slug:** `AMPLITUDE_GET_ANNOTATION_CATEGORY`

Get a single annotation category by ID from Amplitude. Use when you need to retrieve details about a specific annotation category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | Category ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Amplitude Cohort

**Slug:** `AMPLITUDE_GET_COHORT`

Get a single cohort by ID and initiate download. This action allows you to: - Request a specific cohort from Amplitude - Optionally include user properties in the response - Start the asynchronous download process Key features: - Supports filtering by specific user properties - Returns a request ID used for polling status and downloading - Supports EU data residency

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | Cohort ID to retrieve |
| `property_keys` | array | No | User properties to include |
| `include_properties` | boolean | No | Include user properties in response |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Deletion Requests

**Slug:** `AMPLITUDE_GET_DELETION_REQUESTS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_day` | string | Yes | End date for deletion requests in YYYY-MM-DD format |
| `start_day` | string | Yes | Start date for deletion requests in YYYY-MM-DD format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Event Categories

**Slug:** `AMPLITUDE_GET_EVENT_CATEGORIES`

Get event categories from Amplitude. This action allows you to: - Get all event categories in your project - Get a specific category by name

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_name` | string | No | Optional category name to get specific category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Event Property

**Slug:** `AMPLITUDE_GET_EVENT_PROPERTY`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `property` | string | Yes | The event property name to retrieve |
| `event_type` | string | No | The event type associated with the property. Optional but recommended to get event-specific property details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Event Segmentation Data

**Slug:** `AMPLITUDE_GET_EVENT_SEGMENTATION`

Get event segmentation data from Amplitude Analytics API. Use this to analyze event metrics over time with optional grouping by properties. Supports multiple metrics (uniques, totals, percentage of DAU, averages) and time intervals (realtime, hourly, daily, weekly).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `e` | string | Yes | 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"]}]} |
| `g` | string | No | Property to group results by. Use event property names like 'country', 'device_type', etc. |
| `i` | string ("-300000" | "1" | "7" | "30") | No | Time interval for bucketing results: '-300000' (realtime/5-min), '1' (hourly), '7' (daily), '30' (weekly). Default is '1'. |
| `m` | string ("uniques" | "totals" | "pct_dau" | "average") | No | Metric type to calculate. Default is 'uniques'. |
| `end` | string | Yes | End date for the query in YYYYMMDD format |
| `start` | string | Yes | Start date for the query in YYYYMMDD format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Event Type

**Slug:** `AMPLITUDE_GET_EVENT_TYPE`

Get a specific event type from Amplitude by name. This action allows you to: - Retrieve detailed information about a single event type - Get all properties and metadata for the event Key features: - Retrieves comprehensive event type details - Returns metadata like category, description, and settings - Supports lookup by exact event name

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | Yes | The event name to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude Event Types

**Slug:** `AMPLITUDE_GET_EVENT_TYPES`

Get all event types from Amplitude. This action allows you to: - Retrieve all event types in your project - Optionally include deleted events

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `show_deleted` | boolean | No | Whether to include deleted events |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Funnel Analysis Data

**Slug:** `AMPLITUDE_GET_FUNNEL_DATA`

Get 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Real-time Active Users

**Slug:** `AMPLITUDE_GET_REALTIME_ACTIVE_USERS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `i` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Retention Analysis

**Slug:** `AMPLITUDE_GET_RETENTION`

Get 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Revenue LTV Metrics

**Slug:** `AMPLITUDE_GET_REVENUE_LTV`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `i` | integer ("1" | "7" | "30") | No | Interval type for revenue LTV aggregation |
| `m` | integer ("0" | "1" | "2" | "3") | No | Metric type for revenue LTV calculation |
| `end` | string | Yes | End date in YYYYMMDD format (e.g., 20260212) |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., 20260101) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Average Length

**Slug:** `AMPLITUDE_GET_SESSION_AVERAGE`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End date in YYYYMMDD format (e.g., '20260212' for February 12, 2026) |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., '20260113' for January 13, 2026) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Length Distribution

**Slug:** `AMPLITUDE_GET_SESSION_LENGTH`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End date in YYYYMMDD format (e.g., '20260212') |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., '20260205') |
| `timeHistogramConfigBinMax` | integer | No | Maximum value for bucketing (e.g., 600). Must be used with binMin and binSize for custom bucketing. |
| `timeHistogramConfigBinMin` | integer | No | Minimum value for bucketing (e.g., 0). Must be used with binMax and binSize for custom bucketing. |
| `timeHistogramConfigBinSize` | integer | No | Size of each bucket (e.g., 60 for 60-second buckets). Must be used with binMin and binMax for custom bucketing. |
| `timeHistogramConfigBinTimeUnit` | string | No | Time unit for bucket sizes: 'hours', 'minutes', or 'seconds'. If not specified, uses default bucketing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sessions Per User from Amplitude

**Slug:** `AMPLITUDE_GET_SESSIONS_PER_USER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | Yes | End date in YYYYMMDD format (e.g., '20260212') |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., '20260205') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Activity from Amplitude

**Slug:** `AMPLITUDE_GET_USER_ACTIVITY`

Fetch 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Composition by Property

**Slug:** `AMPLITUDE_GET_USER_COMPOSITION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `p` | string | Yes | 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' |
| `end` | string | Yes | End date in YYYYMMDD format (e.g., '20250212') |
| `start` | string | Yes | Start date in YYYYMMDD format (e.g., '20250211') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Mappings

**Slug:** `AMPLITUDE_GET_USER_MAPPINGS`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_ids` | array | Yes | Array of user IDs to get mappings for. Returns the list of mappings that involve the provided user IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Amplitude User Property

**Slug:** `AMPLITUDE_GET_USER_PROPERTY`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_property` | string | Yes | The user property name to retrieve. Custom properties have a 'gp:' prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Properties in Amplitude

**Slug:** `AMPLITUDE_IDENTIFY`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key` | string | No | Your Amplitude API Key for your project. If not provided, will be extracted from authentication credentials. |
| `identification` | string | Yes | Single identification object or array of identifications |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amplitude Annotation Categories

**Slug:** `AMPLITUDE_LIST_ANNOTATION_CATEGORIES`

List all annotation categories from Amplitude. Use to retrieve available categories for chart annotations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | No | When specified, returns only that particular category. Otherwise returns all categories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Chart Annotations

**Slug:** `AMPLITUDE_LIST_ANNOTATIONS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Filter annotations before this ISO 8601 timestamp |
| `start` | string | No | Filter annotations occurring after this ISO 8601 timestamp |
| `category` | string | No | Filter by category name (mutually exclusive with chart_id) |
| `chart_id` | string | No | Filter by chart ID (mutually exclusive with category) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amplitude Cohorts

**Slug:** `AMPLITUDE_LIST_COHORTS`

List 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_sync_info` | boolean | No | Whether to include cohort sync metadata |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amplitude Event Properties

**Slug:** `AMPLITUDE_LIST_EVENT_PROPERTIES`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | No | Filter by event type name. If provided, returns only properties for this specific event type |
| `event_property` | string | No | Filter by property name. If provided, returns only properties matching this name |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amplitude Events

**Slug:** `AMPLITUDE_LIST_EVENTS`

Tool to get a list of all event types in your Amplitude project with current week's statistics. Use when you need to see all events and their recent activity metrics including totals, uniques, and DAU percentages.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Amplitude User Properties

**Slug:** `AMPLITUDE_LIST_USER_PROPERTIES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Map Users in Amplitude

**Slug:** `AMPLITUDE_MAP_USER`

Map 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key` | string | No | Your Amplitude API Key for any project in your organization. If not provided, will be extracted from authentication credentials |
| `mappings` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Amplitude Event Type

**Slug:** `AMPLITUDE_RESTORE_EVENT_TYPE`

Restore 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | Yes | The event name to restore |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Events to Amplitude

**Slug:** `AMPLITUDE_SEND_EVENTS`

Send events to Amplitude using the HTTP V2 API. This action allows you to send events to Amplitude for tracking user behavior and analytics. It supports all Amplitude event fields, handles proper validation, and includes comprehensive error handling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | Yes | Array of events to upload |
| `api_key` | string | No | Your Amplitude API Key for your project. If not provided, will be extracted from the authentication metadata. |
| `options` | object | No | Model for Amplitude API options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Group Properties in Amplitude

**Slug:** `AMPLITUDE_SET_GROUP_PROPERTIES`

Set 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `api_key` | string | No | Your Amplitude API Key for your project. If not provided, will be extracted from authentication credentials. |
| `identification` | string | Yes | Single group identification object or array of identifications (max 1024 per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Amplitude Chart Annotation

**Slug:** `AMPLITUDE_UPDATE_ANNOTATION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | Timestamp in ISO 8601 format for annotation end. Set to null to convert to a point-in-time annotation |
| `label` | string | No | The title of your annotation |
| `start` | string | No | Timestamp in ISO 8601 format for annotation start (e.g., '2026-02-13T00:00:00Z') |
| `details` | string | No | Details for the annotation |
| `category` | string | No | The name of the category that the annotation belongs to |
| `chart_id` | string | No | Chart identifier. Set to null to make annotation visible globally across all charts |
| `annotation_id` | string | Yes | The ID of the annotation to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Amplitude Annotation Category

**Slug:** `AMPLITUDE_UPDATE_ANNOTATION_CATEGORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category` | string | Yes | Updated name for the annotation category |
| `category_id` | string | Yes | ID of the annotation category to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Amplitude Cohort Membership

**Slug:** `AMPLITUDE_UPDATE_COHORT_MEMBERSHIP`

Incrementally 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cohort_id` | string | Yes | Cohort ID to update |
| `count_group` | string | No | Count group of the IDs |
| `memberships` | array | Yes | Membership operations to perform |
| `skip_invalid_ids` | boolean | No | Skip invalid IDs |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Amplitude Event Category

**Slug:** `AMPLITUDE_UPDATE_EVENT_CATEGORY`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | integer | Yes | ID of the category to update |
| `category_name` | string | Yes | New name for the category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Amplitude Event Type

**Slug:** `AMPLITUDE_UPDATE_EVENT_TYPE`

Update 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | string | No | List of tags, separated by a comma |
| `owner` | string | No | Owner of the event type |
| `category` | string | No | Category name for the event type |
| `is_active` | boolean | No | Activity of the event type |
| `event_type` | string | Yes | The event name to update |
| `description` | string | No | Details about the event type |
| `display_name` | string | No | Display name of the event type |
| `new_event_type` | string | No | New name for the event type |
| `is_hidden_from_timeline` | boolean | No | Event type is hidden from timeline |
| `is_hidden_from_dropdowns` | boolean | No | Event type is hidden from dropdowns |
| `is_hidden_from_pathfinder` | boolean | No | Event type is hidden from pathfinder |
| `is_hidden_from_persona_results` | boolean | No | Event type is hidden from persona results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Upload Events to Amplitude

**Slug:** `AMPLITUDE_UPLOAD_BATCH_EVENTS`

Bulk upload events to Amplitude using the Batch Event Upload API. Supports larger payloads (20MB) and higher throttling limits than HTTP V2 API. Use when you need to send large batches of events efficiently.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | Yes | Array of events to upload |
| `api_key` | string | No | Your Amplitude API Key for your project. If not provided, will be extracted from the authentication metadata. |
| `options` | object | No | Model for Amplitude API options |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Amplitude Cohort

**Slug:** `AMPLITUDE_UPLOAD_COHORT`

Generate 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |