> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Amplitude

> How to set up the Amplitude connector, plus the actions and events that are available.

![Amplitude](https://stackone-logos.com/api/amplitude/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/amplitude/changelog.md)

[63 actions](#actions) · [4 events](#events) · 1 auth method

Analytics
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/amplitude/guides/connector-profile/api-key.md)
>
> Basic authentication using API Key and Secret Key for Amplitude Analytics API access.

Optionally, configure receiving Events for Amplitude into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/amplitude/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/amplitude/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

plan:enterprise

region:standard

No scopes found

63 actions

ActionDescriptionRequired scopes

Get Chart Data`amplitude_get_chart_data`

Retrieve data from Amplitude dashboard charts in JSON format for custom reporting and analysis.

Get Events`amplitude_get_events`

Retrieve all event types in the project with current week totals and metrics.

Event Segmentation`amplitude_event_segmentation`

Perform event segmentation analysis to understand how different user segments interact with specific events over time.

Get Active And New User Counts`amplitude_get_active_new_users`

Retrieve counts of active or new users over a specified date range with optional segmentation.

Get Real-Time Active Users`amplitude_get_realtime_active_users`

Retrieve active user counts with 5-minute granularity for the past 2 days.

Get Funnel Analysis`amplitude_get_funnel_analysis`

Retrieve funnel conversion and drop-off rates for a sequence of up to 4 events.

Get Retention Analysis`amplitude_get_retention_analysis`

Retrieve user retention metrics for starting and returning actions over a date range.

Get Revenue LTV`amplitude_get_revenue_ltv`

Retrieve lifetime value metrics for new users including ARPU, ARPPU, total revenue, and paying user counts.

Get Average Session Length`amplitude_get_average_session_length`

Retrieve average session length in seconds for each day in a specified date range.

Get Session Length Distribution`amplitude_get_session_length_distribution`

Retrieve session count distribution across time buckets for a specified date range.

Get Average Sessions Per User`amplitude_get_average_sessions_per_user`

Retrieve the average number of sessions per user for each day in a specified date range.

Get User Composition`amplitude_get_user_composition`

Retrieve the distribution of users across values of a user property in a specified date range.

List Cohorts`amplitude_list_cohorts`

Retrieve a list of all cohorts in your Amplitude project for audience segmentation and behavioral analysis.

Get Cohort`amplitude_get_cohort`

Retrieve detailed information about a specific cohort including its definition, size, and metadata.

Get Cohort Request Status`amplitude_get_cohort_request_status`

Check the status of an asynchronous cohort download request to determine if the cohort data is ready for download.

Download Cohort`amplitude_download_cohort`

Download the list of users in a specific cohort after the async request has completed. Returns user IDs and associated d...

Upload Cohort`amplitude_upload_cohort`

Create a new cohort or update an existing one by uploading a set of user IDs or Amplitude IDs.

Update Cohort Membership`amplitude_update_cohort_membership`

Add or remove users from an existing cohort by incrementally updating its membership.

Send Events`amplitude_send_events`

Send one or more events to Amplitude using the HTTP V2 API for real-time event tracking and user behavior analysis.

Export Events`amplitude_export_events`

Export event data from Amplitude for a specified date range. Returns a gzip-compressed archive of JSON files.

Batch Upload Events`amplitude_batch_upload_events`

Upload multiple events to Amplitude in a single request for efficient bulk event processing.

Group Identify`amplitude_group_identify`

Set or update group properties without sending an event, using the Group Identify API for B2B and account-level analytic...

Get Unified Credentials`amplitude_unified_get_me`

Get the current Amplitude connection's unified credentials and identity.

List Unified Groups`amplitude_unified_list_groups`

List unified groups in the connected Amplitude organization.

`plan:enterprise`

Get Unified Group`amplitude_unified_get_group`

Get a unified group from the connected Amplitude organization.

`plan:enterprise`

List Unified Roles`amplitude_unified_list_roles`

List unified roles in the connected Amplitude organization.

`plan:enterprise`

Get Unified Role`amplitude_unified_get_role`

Get a unified role from the connected Amplitude organization.

`plan:enterprise`

List Unified Users`amplitude_unified_list_users`

List unified users in the connected Amplitude organization.

`plan:enterprise`

Get Unified User`amplitude_unified_get_user`

Get a unified user from the connected Amplitude organization.

`plan:enterprise`

Get Event Categories`amplitude_get_event_categories`

Retrieve all event categories in your Amplitude project for organizing event types.

Get Event Category`amplitude_get_event_category`

Retrieve a specific event category by name.

Create Event Category`amplitude_create_event_category`

Create a new event category for organizing event types in your Amplitude project.

`plan:enterprise`

Update Event Category`amplitude_update_event_category`

Rename an existing event category.

`plan:enterprise`

Delete Event Category`amplitude_delete_event_category`

Remove an event category from your Amplitude project.

`plan:enterprise`

Get Event Types`amplitude_get_event_types`

Retrieve all event types in your Amplitude project with their metadata, categories, and configuration.

Get Event Type`amplitude_get_event_type`

Retrieve details of a specific event type including its properties, category, and configuration.

Create Event Type`amplitude_create_event_type`

Create a new event type in your Amplitude project's taxonomy for tracking and categorization.

`plan:enterprise`

Update Event Type`amplitude_update_event_type`

Update an existing event type's metadata, category, visibility, or other configuration.

`plan:enterprise`

Delete Event Type`amplitude_delete_event_type`

Delete an event type from your Amplitude project's taxonomy.

`plan:enterprise`

Get Event Properties`amplitude_get_event_properties`

Retrieve all properties for a specific event type in your Amplitude taxonomy.

Get Event Property`amplitude_get_event_property`

Retrieve details of a specific event property.

Create Event Property`amplitude_create_event_property`

Create a new event property in your Amplitude taxonomy for a specific event type.

`plan:enterprise`

Update Event Property`amplitude_update_event_property`

Update an existing event property's metadata, type, or configuration.

`plan:enterprise`

Delete Event Property`amplitude_delete_event_property`

Delete an event property from your Amplitude taxonomy.

`plan:enterprise`

Get User Properties`amplitude_get_user_properties`

Retrieve all user properties defined in your Amplitude project's taxonomy.

Get User Property`amplitude_get_user_property`

Retrieve details of a specific user property from your Amplitude taxonomy.

Create User Property`amplitude_create_user_property`

Create a new user property in your Amplitude project's taxonomy for user data governance.

`plan:enterprise`

Update User Property`amplitude_update_user_property`

Update an existing user property's metadata, type, or configuration.

`plan:enterprise`

Delete User Property`amplitude_delete_user_property`

Delete a user property from your Amplitude project's taxonomy.

`plan:enterprise`

Restore Event Type`amplitude_restore_event_type`

Restore a previously deleted event type in your Amplitude project's taxonomy.

`plan:enterprise`

Restore Event Property`amplitude_restore_event_property`

Restore a previously deleted event property in your Amplitude taxonomy.

`plan:enterprise`

Restore User Property`amplitude_restore_user_property`

Restore a previously deleted user property in your Amplitude project's taxonomy.

`plan:enterprise`

List Group Properties`amplitude_list_group_properties`

Retrieve all group properties for a specific group type in your Amplitude taxonomy.

Get Group Property`amplitude_get_group_property`

Retrieve details of a specific group property from your Amplitude taxonomy.

Create Group Property`amplitude_create_group_property`

Create a new group property in your Amplitude taxonomy for a specific group type.

`plan:enterprise`

Update Group Property`amplitude_update_group_property`

Update an existing group property's metadata, type, or configuration.

`plan:enterprise`

List Project Role Assignments`amplitude_list_project_role_assignments`

List explicit project role assignments for users and groups in the Amplitude organization.

`plan:enterprise`

Get User Effective Access`amplitude_get_user_effective_access`

Get the resolved project access for an Amplitude user, including direct, group, and organization-level grants.

`plan:enterprise`

Get Project Effective Access`amplitude_get_project_effective_access`

Get which users and groups can access an Amplitude project, with their role and how access was granted.

`plan:enterprise`

Get User Profile`amplitude_get_user_profile`

Retrieve user profile data including properties, cohort memberships, recommendations, computations, and prediction prope...

`region:standard`

Update User Properties`amplitude_update_user_properties`

Update user properties or associate a device ID with a user ID without sending an event, using the Identify API.

Search Users`amplitude_search_users`

Search for a user by Amplitude ID, device ID, or user ID and retrieve their summary information.

Get User Activity`amplitude_get_user_activity`

Retrieve a user's summary and recent or earliest events by their Amplitude ID.

## Events

Tags

Select all
|
Clear

Cohorts

Events

Users

Webhooks

No tags found

4 events

EventDescriptionTags

Event Streamed`amplitude_webhook_event_streamed`

Fired when Amplitude streams an ingested analytics event (event.streamed).

EventsWebhooks

User Streamed`amplitude_webhook_user_streamed`

Fired when Amplitude streams a user-property update (user.streamed).

UsersWebhooks

Cohort Users Entered`amplitude_webhook_cohort_users_entered`

Fired when a cohort sync delivers users who entered a synced cohort (cohort.users\_entered).

CohortsWebhooks

Cohort Users Exited`amplitude_webhook_cohort_users_exited`

Fired when a cohort sync delivers users who left a synced cohort (cohort.users\_exited).

CohortsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.