amplitude · 54 tools · no triggers
Connect it
run auth amplitude
run auth amplitude --scope team # shared with the organization
Use it
run amplitude # common commands
run amplitude --all # every command
import { amplitude } from "@boxd/run";
Common tools
| Tool | What it does |
|---|---|
cancel-deletion | Cancel a pending user deletion request in Amplitude. Use this to remove a user from a scheduled deletion job before it completes. |
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… |
download-cohort-file | Download the cohort file after request is complete. Use this action after checking that the cohort status is ‘JOB COMPLETED’. |
find-user | Search for users in Amplitude by canonical identifier (Amplitude ID, device ID, user ID, or user ID prefix). |
get-active-users | Get the number of active or new users for a date range with optional segmentation. |
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… |
get-funnel-data | Get funnel analysis data showing user conversion through a sequence of events. |
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. |
get-retention | Get user retention analysis showing how users return over time after a starting action. |
get-session-average | Get average session length (in seconds) for a specified date range from Amplitude. |
get-session-length | Tool to retrieve session length distribution data for a specified date range from Amplitude. |
get-user-activity | Fetch a single user’s profile summary and event stream by Amplitude ID. |
get-user-composition | Tool to get user composition breakdown by property (platform, version, country, etc.). |
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. |
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… |
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… |
map-user | Map users with different user IDs together (alias/merge users) in 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. |
set-group-properties | Set group properties for account-level reporting without sending an event. |
upload-batch-events | Bulk upload events to Amplitude using the Batch Event Upload API. |
All 54 tools
All 54 tools
| Tool | What it does |
|---|---|
assign-annotations-to-category | Tool to bulk assign multiple annotations to a category in 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. |
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… |
create-annotation | Create a chart annotation in Amplitude to mark important dates. |
create-annotation-category | Tool to create an annotation category in Amplitude to organize annotations. |
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… |
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… |
create-release | Create a release to document product changes. Use when you want to track app version releases and their impact on metrics. |
delete-annotation | Delete a chart annotation from Amplitude. Use to remove existing annotations from charts. |
delete-annotation-category | Delete an annotation category from Amplitude. Use when you need to remove an annotation category that is no longer needed. |
delete-event-category | Delete an event category from Amplitude. This action allows you to: - Delete an existing event category - Remove category organization from events… |
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… |
delete-users | Submit user deletion requests for GDPR/CCPA compliance. Supports up to 100 users per request. |
download-cohort-file | Download the cohort file after request is complete. Use this action after checking that the cohort status is ‘JOB COMPLETED’. |
find-user | Search for users in Amplitude by canonical identifier (Amplitude ID, device ID, user ID, or user ID prefix). |
get-active-users | Get the number of active or new users for a date range with optional segmentation. |
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… |
get-annotation-category | Get a single annotation category by ID from Amplitude. Use when you need to retrieve details about a specific annotation category. |
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… |
get-deletion-requests | Get the status of user deletion requests within a date range. |
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 |
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… |
get-event-segmentation | Get event segmentation data from Amplitude Analytics API. Use this to analyze event metrics over time with optional grouping by properties. |
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… |
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 |
get-funnel-data | Get funnel analysis data showing user conversion through a sequence of events. |
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. |
get-retention | Get user retention analysis showing how users return over time after a starting action. |
get-revenue-ltv | Get revenue lifetime value (LTV) metrics including ARPU, ARPPU, and total revenue. |
get-session-average | Get average session length (in seconds) for a specified date range from Amplitude. |
get-session-length | Tool to retrieve session length distribution data for a specified date range from Amplitude. |
get-sessions-per-user | Tool to get average number of sessions per user for each day in a date range from Amplitude. |
get-user-activity | Fetch a single user’s profile summary and event stream by Amplitude ID. |
get-user-composition | Tool to get user composition breakdown by property (platform, version, country, etc.). |
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. |
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… |
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… |
list-annotation-categories | List all annotation categories from Amplitude. Use to retrieve available categories for chart annotations. |
list-annotations | Tool to get all chart annotations with optional filtering by category, chart, and date range. |
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… |
list-event-properties | Get all event properties from Amplitude, optionally filtered by event type or property name. |
list-events | Tool to get a list of all event types in your Amplitude project with current week’s statistics. |
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… |
map-user | Map users with different user IDs together (alias/merge users) in 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… |
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. |
set-group-properties | Set group properties for account-level reporting without sending an event. |
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. |
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. |
update-cohort-membership | Incrementally update cohort membership by adding or removing IDs. |
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… |
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… |
upload-batch-events | Bulk upload events to Amplitude using the Batch Event Upload API. |
upload-cohort | Generate a new cohort or update an existing cohort by uploading user IDs or Amplitude IDs. |