Amplitude

Learn how to use Amplitude with Composio

Overview

Enum

AMPLITUDE

Description

Amplitude Inc. is an American publicly trading company that develops digital analytics software.

Authentication Details

username
stringRequired
password
stringRequired

Actions

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

Action Parameters

category_id
integerRequired
category_name
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

include_sync_info
boolean

Action Response

data
object
successful
boolean
error

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

Action Parameters

cohort_id
stringRequired
memberships
arrayRequired
count_group
string
skip_invalid_ids
booleanDefaults to True

Action Response

data
object
successful
boolean
error

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

Action Parameters

request_id
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

event_type
stringRequired

Action Response

data
object
successful
boolean
error

Get all event types from amplitude. this action allows you to: - retrieve all event types in your project - optionally include deleted events

Action Parameters

show_deleted
boolean

Action Response

success
boolean
data
errors
successful
boolean
error

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

Action Parameters

identification
objectRequired
api_key
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

category_id
integerRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

event_type
stringRequired
category
string
description
string
is_active
boolean
is_hidden_from_dropdowns
boolean
is_hidden_from_persona_results
boolean
is_hidden_from_pathfinder
boolean
is_hidden_from_timeline
boolean
tags
string
owner
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

cohort_id
stringRequired
include_properties
boolean
property_keys
array

Action Response

data
object
successful
boolean
error

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

Action Parameters

category_name
stringRequired

Action Response

data
object
successful
boolean
error

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

Action Parameters

event_type
stringRequired

Action Response

success
boolean
data
errors
successful
boolean
error

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

Action Parameters

category_name
string

Action Response

success
boolean
data
errors
successful
boolean
error

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)

Action Parameters

event_type
stringRequired
new_event_type
string
category
string
description
string
display_name
string
is_active
boolean
is_hidden_from_dropdowns
boolean
is_hidden_from_persona_results
boolean
is_hidden_from_pathfinder
boolean
is_hidden_from_timeline
boolean
tags
string
owner
string

Action Response

data
object
successful
boolean
error

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

Action Parameters

event_type
stringRequired

Action Response

data
object
successful
boolean
error

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.

Action Parameters

api_key
stringRequired
events
arrayRequired
options
object

Action Response

data
object
successful
boolean
error