Skip to content
Changelog

Report a bug

Amplitude integration: operations for AI agents

Amplitude connects to Type.com as an integration. This page lists the 258 operations documented for Claude and Codex in Type.com: 132 read, 81 write, 45 destructive.

About Amplitude

Amplitude’s US project Basic-auth connection. Of 258 sourced vendor reference routes, 72 match this preset’s host/auth transport; 186 require another host, credential, transport or retired API as described by their API contracts. Operations also require the corresponding account entitlements.

Categories: Analytics & Data

How to connect Amplitude to Type.com

Connect
US project API key + matching project secret (HTTP Basic); fixed https://amplitude.com target
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

258 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

258 operations listed.

Agent Analytics export

  • Read

    List sessions

    Returns a paginated list of sessions for the authenticated project, with metadata and human review. Traces, spans, and turns come from the single-session endpoint.

    GET /v1/agent-analytics/export/sessions

  • Read

    Get one session

    Returns one session with its full traces, spans, sanitized turns, evaluation results, enrichments, and dataset memberships.

    GET /v1/agent-analytics/export/sessions/{session_id}

  • Read

    Get a dataset

    Returns a dataset with a paginated list of its member sessions, including ground-truth labels and human review.

    GET /v1/agent-analytics/export/datasets/{dataset_id}

  • Read

    Get an evaluator configuration

    Returns one evaluator configuration, including its prompt, model, and labels, so you can reproduce the same judgment in your own tooling.

    GET /v1/agent-analytics/export/evaluators/{evaluator_id}

AI feedback

  • Write

    Ingest feedback

    Sends customer feedback items to Amplitude. Each item can include conversation parts for threaded feedback such as support tickets, call transcripts, or chat conversations.

    POST /api/1/ai-feedback/ingest

Attribution

  • Write

    Send attribution event

    Send attribution campaign events (identified by `idfa`, `idfv`, or `adid`) that contain attribution information.

    POST /attribution

Event ingestion

  • Write

    Upload events in batch

    Upload large amounts of event data.

    POST /batch

  • Write

    Update group properties

    Set or update properties of particular groups.

    POST /groupidentify

  • Write

    Send events

    Choose your target platform to send a POST request to https://api2.amplitude.com/2/httpapi (or https://api.eu.amplitude.com/2/httpapi for EU residency). Replace YOUR_API_KEY with the API KEY for your Amplitude project.

    POST /2/httpapi

  • Write

    Update user properties

    Set the User ID for a particular Device ID or update user properties of a particular user without sending an event.

    POST /identify

Cohorts

  • Read

    Get all cohorts

    Get all discoverable cohorts for an app. Use the id for each cohort returned in the response to get a single cohort.

    GET /api/3/cohorts

  • Read

    Get request status

    Poll the request status using the request_id retrieved for the cohort. This is step two of the cohort download operation.

    GET /api/5/cohorts/request-status/{request_id}

  • Read

    Download cohort

    After the job finishes running, download the cohort. The following is a basic request.

    GET /api/5/cohorts/request/{requestId}/file

  • Read

    Get usage

    Check your current monthly usage and limit for the Behavioral Cohorts Download API.

    GET /api/3/cohorts/usage

  • Write

    Request cohort export

    Get a discoverable cohort using its cohort_id. This is step one of the cohort download operation.

    GET /api/5/cohorts/request/{id}

  • Write

    Upload cohort

    Generate a new cohort or update an existing cohort by uploading a set of User IDs or Amplitude IDs. The following is a basic request example with placeholder values.

    POST /api/3/cohorts/upload

  • Write

    Update cohort membership

    Add and remove IDs to update existing cohort membership incrementally.

    POST /api/3/cohorts/membership

Privacy

  • Read

    Get request status

    Poll the data request job to get its status.

    GET /api/2/dsar/requests/{request-id}

  • Read

    Get output files

    Download a returned output file.

    GET /api/2/dsar/requests/{request_id}/outputs/{output_id}

  • Read

    List deletion requests

    Returns all deletion requests for the organization.

    GET /api/user-deletions/org/{orgId}/requests

  • Read

    Get a deletion request

    Returns a single deletion request by ID.

    GET /api/user-deletions/org/{orgId}/requests/{requestId}

  • Read

    Get deletion jobs

    Retrieves a list of deletion jobs scheduled in a time range. The time range should include the date you made the request on plus 30 days.

    GET /api/2/deletions/users

  • Write

    Create a request for data

    The California Consumer Privacy Act (CCPA) requires businesses to provide all data about an end user upon request. This Data Subject Access Request (DSAR) API makes it easy to retrieve all data about a user.

    POST /api/2/dsar/requests

  • Destructive

    Submit a deletion request

    Add users for deletion using a JSON body (DeletionRequest). Specify up to 100,000 users at a time.

    POST /api/user-deletions/org/{orgId}/requests

  • Destructive

    Delete users

    Add a user for deletion using a JSON body. Specify up to 100 users at a time. Corrected the surviving missing /api/2 path prefix against the current vendor request examples.

    POST /api/2/deletions/users

  • Destructive

    Remove user from deletion job

    Removes a user from a pending deletion job (v1 privacy API).

    DELETE /api/2/deletions/users/{amplitude_id}/{date}

Channel classifiers

  • Read

    List classifiers

    Returns every channel classifier in the authenticated project.

    GET /api/2/channel-classifiers

  • Read

    Get a classifier by name

    Returns the full definition for a single classifier by its name.

    GET /api/2/channel-classifiers/{name}

  • Write

    Create a classifier

    Creates a new classifier under the name you provide. Fails with 409 if a classifier with that name already exists in the project.

    POST /api/2/channel-classifiers/{name}

  • Write

    Update a classifier

    Replaces the definition of an existing classifier with the full csvDefinition from the request body. Amplitude doesn't support partial CSV updates, and updates displayName and description only when you supply them.

    PATCH /api/2/channel-classifiers/{name}

Chart annotations

  • Read

    Get all annotation categories

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    GET /api/3/annotation-categories

  • Read

    Get an annotation category by ID

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    GET /api/3/annotation-categories/{category_id}

  • Read

    Get all annotations

    Retrieves all chart annotations in your project. Supports filtering by category, chart, and date range.

    GET /api/3/annotations

  • Read

    Get a single annotation

    Retrieves a single chart annotation by ID.

    GET /api/3/annotations/{annotation_id}

  • Write

    Create an annotation category

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    POST /api/3/annotation-categories

  • Write

    Create an annotation

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    POST /api/3/annotations

  • Destructive

    Update an annotation category

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    PUT /api/3/annotation-categories/{category_id}

  • Destructive

    Delete an annotation category

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    DELETE /api/3/annotation-categories/{category_id}

  • Destructive

    Bulk update annotation categories

    Assign a category to multiple annotations at once.

    PUT /api/3/annotation-categories/bulk/{category_id}

  • Destructive

    Update an annotation

    Updates a specific annotation. Supports partial updates.

    PUT /api/3/annotations/{annotation_id}

  • Destructive

    Delete an annotation

    Programmatically annotate important dates and time ranges like feature releases and marketing campaigns on your organization's charts. Organize annotations into categories and use hourly granularity for precise timing.

    DELETE /api/3/annotations/{annotation_id}

Dashboard REST

  • Read

    Get results from an existing chart

    Get JSON results from any saved chart by chart ID. GET https://amplitude.com/api/3/chart/chart_id/csv

    GET /api/3/chart/{chart_id}/csv

  • Read

    Get active and new user counts

    Get the number of active or new users.

    GET /api/2/users

  • Read

    Get session length distribution

    Get the number of sessions for each predefined length (bucket) period during a specified date range.

    GET /api/2/sessions/length

  • Read

    Get average session length

    Get the average session length (in seconds) for each day in the specified date range.

    GET /api/2/sessions/average

  • Read

    Get average sessions per user

    Get the average number of sessions per user on each day in the specified date range.

    GET /api/2/sessions/peruser

  • Read

    User composition

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

    GET /api/2/composition

  • Read

    Get events list

    Get the list of events with the current week's totals, uniques, and % DAU (daily active users).

    GET /api/2/events/list

  • Read

    Event segmentation

    Get metrics for an event with segmentation.

    GET /api/2/events/segmentation

  • Read

    Funnel analysis

    Get funnel drop-off and conversion rates.

    GET /api/2/funnels

  • Read

    Retention analysis

    Get user retention for specific starting and returning actions.

    GET /api/2/retention

  • Read

    User activity

    Get a user summary and the user's most or least recent events. Exceeding the request limits returns 429 errors.

    GET /api/2/useractivity

  • Read

    User search

    Search for a user by Amplitude ID, device ID, user ID, or user ID prefix. Exceeding the request limits returns 429 errors.

    GET /api/2/usersearch

  • Read

    Real-time active users

    Get active user numbers with 5-minute granularity for the last two days.

    GET /api/2/realtime

  • Read

    Revenue lifetime value

    Get the lifetime value of new users.

    GET /api/2/revenue/ltv

Event streaming

  • Read

    Get event streaming delivery metrics

    Get delivery metrics summary for a configured event stream.

    GET /api/2/event-streaming/delivery-metrics-summary

Export

  • Read

    Export raw event data

    Export your project's event data.

    GET /api/2/export

Lookup tables

  • Read

    Get lookup table

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    GET /api/3/lookup_table/{name}

  • Read

    Download lookup table CSV

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    GET /api/3/lookup_table/{name}/csv

  • Read

    List lookup tables

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    GET /api/3/lookup_table

  • Read

    Get lookup table (v1 API) (deprecated)

    Augment your properties with static data.

    GET /api/2/lookup_table/{name}

  • Read

    List all lookup tables (deprecated)

    List all the Lookup Tables for the project.

    GET /api/2/lookup_table

  • Write

    Create lookup table

    Create a lookup table by uploading a CSV file and its configuration; this is a multipart upload, not the GET list operation.

    POST /api/3/lookup_table

  • Write

    Update lookup table

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    PATCH /api/3/lookup_table/{name}

  • Write

    Create lookup table (v1 API) (deprecated)

    Augment your properties with static data.

    POST /api/2/lookup_table/{name}

  • Write

    Update lookup table (v1 API) (deprecated)

    Augment your properties with static data.

    PATCH /api/2/lookup_table/{name}

  • Destructive

    Override lookup table

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    PUT /api/3/lookup_table/{name}

  • Destructive

    Delete lookup table

    The base URL depends on your project's data residency. In all examples on this page, use the default base URL unless your project uses Amplitude's EU data center—in that case use the EU base URL in this table.

    DELETE /api/3/lookup_table/{name}

  • Destructive

    Delete lookup table (v1 API) (deprecated)

    Augment your properties with static data.

    DELETE /api/2/lookup_table/{name}

Releases

  • Write

    Create a release

    Send the release's parameters as a JSON payload or as query parameters.

    POST /api/2/release

SCIM

  • Read

    Get users

    Gets a list of users within Amplitude for that organization. This includes both pending and joined users, and supports pagination and filtering.

    GET /scim/1/Users

  • Read

    Get user by ID

    Gets a user by their ID.

    GET /scim/1/Users/{id}

  • Read

    Get groups

    Host: core.amplitude.com

    GET /scim/1/Groups

  • Read

    Get group by ID

    Returns the Amplitude group with the given numeric ID.

    GET /scim/1/Groups/{id}

  • Write

    Create users

    A POST request creates a new user in Amplitude. This operation sends an invitation link to the email address.

    POST /scim/1/Users

  • Write

    Create a group

    Creates a group in Amplitude. This route adds existing users to the group and invites new users to Amplitude.

    POST /scim/1/Groups

  • Write

    Update a user group

    Use PATCH requests to add or remove users from a group. The Operations array supports add and remove operations.

    PATCH /scim/1/Groups/{id}

  • Write

    Update user

    Updates fields of a user in the organization through SCIM.

    PATCH /scim/1/Users/{id}

  • Destructive

    Replace user

    Updates the Amplitude user with the given ID. id must be a valid email address, and the user must already have an invitation to Amplitude.

    PUT /scim/1/Users/{id}

  • Destructive

    Delete a user

    Deletes the Amplitude user with the given ID. The ID must be a valid email, and the user must already have an invitation to Amplitude.

    DELETE /scim/1/Users/{id}

  • Destructive

    Delete group

    Deletes an Amplitude group.

    DELETE /scim/1/Groups/{id}

Session Replay

  • Read

    List session replays

    Returns a paginated list of session replays for the authenticated project.

    GET /api/1/session-replays

  • Read

    Get session replay files

    Returns a paginated list of presigned S3 URLs for the event files belonging to a specific replay. Each URL points to a gzip-compressed JSON array of rrweb events.

    GET /api/1/session-replays/files

Taxonomy (legacy)

  • Read

    Get all event categories

    Get all event categories in your project.

    GET /api/2/taxonomy/category

  • Read

    Get an event category

    Get the ID of an event category in your project by sending a GET request with the category name.

    GET /api/2/taxonomy/category/{category_name}

  • Read

    Get all event types

    Retrieves all event types in a project. This request has no required parameters.

    GET /api/2/taxonomy/event

  • Read

    Get an event type

    Get a single event type by name. Send a GET request with the event name.

    GET /api/2/taxonomy/event/{event_type}

  • Read

    Get event properties

    Get shared or event-specific event properties.

    GET /api/2/taxonomy/event-property

  • Read

    Get all user properties

    Retrieves all user properties in your account. The request has no required parameters.

    GET /api/2/taxonomy/user-property

  • Read

    Get a user property

    Retrieves a single user property by name.

    GET /api/2/taxonomy/user-property/{user_property}

  • Read

    Get group properties

    Get shared or group-specific group properties.

    GET /api/2/taxonomy/group-property

  • Read

    Get a single group property

    Get a single group property by sending a GET request with the group property name as a path parameter. Optionally include the group type in the body.

    GET /api/2/taxonomy/group-property/{group_property}

  • Write

    Create event category

    Create an event category in your project.

    POST /api/2/taxonomy/category

  • Write

    Create an event type

    Create an event type by sending a POST request to https://amplitude.com/api/2/taxonomy/event with parameters in the body.

    POST /api/2/taxonomy/event

  • Write

    Restore an event type

    Restore an event type by sending a POST request with the event type name as a path parameter.

    POST /api/2/taxonomy/event/{event_type}/restore

  • Write

    Create an event property

    Create an event property by sending a POST request with the required information in the body.

    POST /api/2/taxonomy/event-property

  • Write

    Restore an event property

    Restore an event property by sending a POST request with the event property as a path parameter.

    POST /api/2/taxonomy/event-property/{event-property}/restore

  • Write

    Create a user property

    Create a user property by sending a POST request with the user property name in the body.

    POST /api/2/taxonomy/user-property

  • Write

    Restore a user property

    Restore a single user property by name.

    POST /api/2/taxonomy/user-property/{user_property}/restore

  • Write

    Create a group property

    Create a group property by sending a POST request with the required information in the body.

    POST /api/2/taxonomy/group-property

  • Destructive

    Update an event category

    Update the name of an event category by sending a PUT request with the category ID and a new name in the body.

    PUT /api/2/taxonomy/category/{category_id}

  • Destructive

    Delete an event category

    Delete an event category by sending a DELETE request with the category ID.

    DELETE /api/2/taxonomy/category/{category_id}

  • Destructive

    Update an event type

    Update an event type by sending a PUT request with the event type name.

    PUT /api/2/taxonomy/event/{event_type}

  • Destructive

    Delete an event type

    Delete an event type by sending a DELETE request with the event type name as a path parameter.

    DELETE /api/2/taxonomy/event/{event_type}

  • Destructive

    Update event property

    Update an event property by sending a PUT request with the event property name as a path parameter.

    PUT /api/2/taxonomy/event-property/{event-property}

  • Destructive

    Delete an event property

    Delete an event property by sending a DELETE request with the event property as a path parameter. Optionally include the event type in the request body.

    DELETE /api/2/taxonomy/event-property/{event-property}

  • Destructive

    Update a user property

    Update a user property by sending a PUT request with the user property name as a path parameter.

    PUT /api/2/taxonomy/user-property/{user_property}

  • Destructive

    Delete a user property

    Deletes a single user property by name.

    DELETE /api/2/taxonomy/user-property/{user_property}

  • Destructive

    Update group property

    Update a group property by sending a PUT request with the group property name as a path parameter.

    PUT /api/2/taxonomy/group-property/{group_property}

User mapping

  • Read

    Get existing user mappings

    Lists the existing user mappings for a global user ID.

    GET /api/2/usermap

  • Destructive

    User mapping

    Map a user ID to a global user ID. You can map a single user ID per JSON mapping object. The same POST route also accepts unmap=true to remove an identity mapping; inspect the requested effect. Variant Unmap users: Removes an existing mapping between a user ID and a global user ID.

    POST /usermap

User profile

  • Read

    Get a recommendation

    Read the Enterprise user profile endpoint. Query flags select recommendations (single/multiple), user properties, cohort IDs, computations or prediction propensity; these are response/query variants of one transport route. Variant Get multiple recommendations: Gets several recommendation results for a user in one request. Variant Get user properties: Gets all user properties for a user by user ID or device ID. Variant Get cohort IDs: Gets the IDs of all cohorts a user belongs to. Variant Get all computations: Gets all computed properties for a user. Variant Get computation by ID: Gets one computed property for a user. Variant Get prediction propensity: Gets one or more prediction propensity scores for a user.

    GET /v1/userprofile

Audit logs

  • Read

    Retrieve audit events

    Programmatically export audit events for security monitoring, compliance, and operational reporting.

    POST /api/2/audit-logs/{id}

Developer auth

  • Write

    OAuth device flow

    Use the device flow to authorize a CLI, script, or other input-constrained client without embedding a client secret. The flow has two steps: start a device authorization request, then poll for a token.

    POST /v1/auth/device-authorization

  • Write

    Exchange a grant for tokens

    RFC 6749 §3.2 token endpoint. Supports the device_code grant (RFC 8628) and the refresh_token grant.

    POST /v1/auth/token

  • Write

    Sign up for an Amplitude account

    Sign up for an Amplitude account. The response either provides credentials for the new account or starts an OAuth flow to complete signup.

    POST /v1/auth/signup

Agent Analytics

  • Read

    Get a saved Agent Analytics insight

    Returns one finding by its stable UUID and own project_id. Missing, cross-project, and thumbs-downed findings return 404.

    GET /v1/projects/{project_id}/agent-analytics/insights/{insight_id}

  • Read

    Get an Agent Analytics eval run

    Returns one eval run by id, including progress counters and, once the run

    GET /v1/projects/{project_id}/agent-analytics/eval-runs/{eval_run_id}

  • Read

    List Agent Analytics eval runs

    Returns eval runs for the project, most recent first. A run is a batch

    GET /v1/projects/{project_id}/agent-analytics/eval-runs

  • Read

    List saved Agent Analytics insights

    Returns saved cost, efficiency, and quality findings, ranked by magnitude

    GET /v1/projects/{project_id}/agent-analytics/insights

  • Write

    Add sessions to an Agent Analytics dataset

    Adds sessions to a dataset. Sessions already in the dataset are ignored, so

    POST /v1/projects/{project_id}/agent-analytics/datasets/{dataset_id}/sessions

  • Write

    Create an Agent Analytics dataset

    Creates an empty dataset. Add sessions with the dataset sessions endpoint.

    POST /v1/projects/{project_id}/agent-analytics/datasets

  • Write

    Create an Agent Analytics evaluator

    Creates an evaluator in the inactive state. Activation is a separate

    POST /v1/projects/{project_id}/agent-analytics/evaluators

  • Write

    Trigger an Agent Analytics eval run

    Starts an asynchronous eval run and returns it immediately with a pending

    POST /v1/projects/{project_id}/agent-analytics/eval-runs

  • Write

    Update an Agent Analytics dataset

    Updates dataset metadata. Absent fields are unchanged; an explicit null

    PATCH /v1/projects/{project_id}/agent-analytics/datasets/{dataset_id}

  • Write

    Update an Agent Analytics evaluator

    Updates an evaluator addressed by its stable identifier. Absent fields are

    PATCH /v1/projects/{project_id}/agent-analytics/evaluators/{evaluator_stable_id}

  • Destructive

    Remove sessions from an Agent Analytics dataset

    Removes sessions from a dataset. The sessions themselves are untouched;

    DELETE /v1/projects/{project_id}/agent-analytics/datasets/{dataset_id}/sessions

Charts and metrics

  • Read

    Check recent event ingestion with an ingestion API key

    Checks whether Amplitude received any events for the project associated

    POST /v1/events/check-recent-ingestion

  • Read

    Check recent event ingestion

    Checks whether events reached an Amplitude project during a recent time

    POST /v1/projects/{project_id}/events/check-recent-ingestion

  • Read

    Get chart

    Returns chart metadata. The chart definition is omitted by default.

    GET /v1/projects/{project_id}/charts/{chart_id}

  • Read

    Get metric

    Returns the full saved metric definition including type-specific params,

    GET /v1/projects/{project_id}/metrics/{metric_id}

  • Read

    List charts

    Returns saved charts in the project. Results are paginated with cursor-based

    GET /v1/projects/{project_id}/charts

  • Read

    List metrics

    Returns saved metrics in the project. Results are paginated with cursor-based

    GET /v1/projects/{project_id}/metrics

  • Read

    Query chart

    Computes and returns normalized results for a saved chart. v1 supports

    POST /v1/projects/{project_id}/charts/{chart_id}/query

Destinations

  • Read

    Get a destination

    Gets a single a destination by its ID.

    GET /v1/projects/{project_id}/destinations/{id}

  • Read

    Get destination partner type

    Gets a single destination partner type by its ID.

    GET /v1/destination-types/{partner}

  • Read

    List destination partner types

    Lists destination partner types in the project.

    GET /v1/destination-types

  • Read

    List destinations

    Lists destinations in the project.

    GET /v1/projects/{project_id}/destinations

  • Write

    Create a destination

    Always creates a new destination; the server assigns the id used for

    POST /v1/projects/{project_id}/destinations

  • Write

    Generate an RSA key pair for Snowflake authentication

    Generates a Snowflake-compatible RSA key pair. The private key is stored

    POST /v1/projects/{project_id}/snowflake-keys

  • Write

    Test an event streaming destination connection

    Test an event streaming destination connection in Amplitude.

    POST /v1/projects/{project_id}/destinations/{id}/test

  • Write

    Update a destination

    Updates an existing a destination.

    PATCH /v1/projects/{project_id}/destinations/{id}

Feature flags

  • Read

    Get feature flag

    Gets a single feature flag by its ID.

    GET /v1/projects/{project_id}/flags/{flag_id}

  • Read

    List feature flags

    Lists feature flags in the project.

    GET /v1/projects/{project_id}/flags

  • Write

    Create feature flag

    Creates a new feature flag.

    POST /v1/projects/{project_id}/flags

  • Write

    Update feature flag

    Updates feature flag metadata and rollout settings. Variant, tester, deployment, and link mutations will be exposed through dedicated subresources in a later slice.

    PATCH /v1/projects/{project_id}/flags/{flag_id}

  • Destructive

    Archive feature flag

    Archives a feature flag so it is no longer active.

    DELETE /v1/projects/{project_id}/flags/{flag_id}

Guides

  • Read

    Get guide

    Gets a single guide by its ID.

    GET /v1/projects/{project_id}/guides/{guide_id}

  • Read

    List guides

    Returns guides in the project. Results use the standard

    GET /v1/projects/{project_id}/guides

  • Write

    Create guide

    Creates an unpublished draft guide. Publish, schedule, and test

    POST /v1/projects/{project_id}/guides

  • Write

    Update guide

    Updates metadata, targeting, and content variants. For published guides,

    PATCH /v1/projects/{project_id}/guides/{guide_id}

  • Destructive

    Archive guide

    Archives an unpublished guide. A guide counts as published while its flag is

    DELETE /v1/projects/{project_id}/guides/{guide_id}

Heatmaps

  • Read

    Query click map

    Returns click counts for one page URL, grouped by the CSS selector of the

    POST /v1/projects/{project_id}/heatmaps/click-map

  • Read

    Query scroll map

    Returns the scroll-depth distribution for one page URL as a cumulative

    POST /v1/projects/{project_id}/heatmaps/scroll-map

MCP Analytics

  • Read

    Get an MCP episode

    Returns one episode, including its project, server, auth type, and topic

    GET /v1/projects/{project_id}/mcp-analytics/episodes/{episode_id}

  • Read

    Get an MCP taxonomy topic

    Returns one topic and up to eight example episodes. Examples are not a

    GET /v1/projects/{project_id}/mcp-analytics/servers/{server_id}/topics/{topic_id}

  • Read

    Get the active MCP taxonomy

    Returns the server's active topic tree. The resource id is the server id.

    GET /v1/projects/{project_id}/mcp-analytics/servers/{server_id}/taxonomy

  • Read

    List episodes for an MCP topic

    Returns a page of episode summaries for one topic. The default page size

    GET /v1/projects/{project_id}/mcp-analytics/servers/{server_id}/topics/{topic_id}/episodes

  • Read

    List MCP Analytics servers

    Returns the MCP servers configured for the project. A project with no MCP

    GET /v1/projects/{project_id}/mcp-analytics/servers

Projects

  • Read

    Get authenticated context

    Returns the authenticated principal and organization context.

    GET /v1/context

  • Read

    List projects

    Returns projects visible to the authenticated principal.

    GET /v1/projects

Skills

  • Read

    Get a skill document

    Returns the requested skill document verbatim as markdown, including frontmatter.

    GET /v1/skills/{name}

  • Read

    List available skills

    Returns the skills currently available for implementing Amplitude, with each skill's name and when-to-use description.

    GET /v1/skills

Surveys

  • Read

    Get survey

    Gets a single survey by its ID.

    GET /v1/projects/{project_id}/surveys/{survey_id}

  • Read

    List surveys

    Returns surveys in the project. Results use the standard Developer API list

    GET /v1/projects/{project_id}/surveys

  • Write

    Create survey

    Creates an unpublished draft survey. Publish, schedule, and test

    POST /v1/projects/{project_id}/surveys

  • Write

    Update survey

    Updates metadata, targeting, and content variants. For published surveys,

    PATCH /v1/projects/{project_id}/surveys/{survey_id}

  • Destructive

    Archive survey

    Archives an unpublished survey. A survey counts as published while its flag

    DELETE /v1/projects/{project_id}/surveys/{survey_id}

Taxonomy

  • Read

    Get event property

    Gets a single event property by its ID.

    GET /v1/projects/{project_id}/events/{event_id}/event-properties/{event_property_id}

  • Read

    List event properties for an event

    Returns properties bound to a specific event, including ingested-only

    GET /v1/projects/{project_id}/events/{event_id}/event-properties

  • Read

    Get event taxonomy entry

    Gets a single event taxonomy entry by its ID.

    GET /v1/projects/{project_id}/events/{event_id}

  • Read

    List event taxonomy entries

    Lists event taxonomy entries in the project.

    GET /v1/projects/{project_id}/events

  • Read

    Get user property

    Gets a single user property by its ID.

    GET /v1/projects/{project_id}/user-properties/{user_property_id}

  • Read

    List user properties for a project

    Lists user properties for a project in the project.

    GET /v1/projects/{project_id}/user-properties

  • Write

    Create event property

    Creates an event property and adds it to the project's tracking plan

    POST /v1/projects/{project_id}/events/{event_id}/event-properties

  • Write

    Update event property metadata

    Updates metadata on an event property. Returns 422 not_in_schema if

    PATCH /v1/projects/{project_id}/events/{event_id}/event-properties/{event_property_id}

  • Write

    Create event taxonomy entry

    Creates a new event taxonomy entry.

    POST /v1/projects/{project_id}/events

  • Write

    Update event taxonomy entry

    Updates an existing event taxonomy entry.

    PATCH /v1/projects/{project_id}/events/{event_id}

  • Write

    Create user property

    Creates a user property and adds it to the project's tracking plan.

    POST /v1/projects/{project_id}/user-properties

  • Write

    Update user property metadata

    Updates metadata on a user property. Returns 422 not_in_schema if the

    PATCH /v1/projects/{project_id}/user-properties/{user_property_id}

  • Destructive

    Delete event property

    Permanently deletes a event property.

    DELETE /v1/projects/{project_id}/events/{event_id}/event-properties/{event_property_id}

  • Destructive

    Soft-delete event taxonomy entry

    Soft-delete event taxonomy entry in Amplitude.

    DELETE /v1/projects/{project_id}/events/{event_id}

  • Destructive

    Delete user property

    Permanently deletes a user property.

    DELETE /v1/projects/{project_id}/user-properties/{user_property_id}

Zoning

  • Read

    Query zone metrics

    Returns one metric for every zone on a page URL, ranked by value. A zone

    POST /v1/projects/{project_id}/zoning/zone-metrics

Experiment evaluation

  • Read

    Evaluate flags for a user

    Lets you retrieve variant assignment data for users with remote evaluation.

    GET /v1/vardata

  • Read

    Get flag configurations

    Gets flag configurations for local evaluation in server-side SDKs.

    GET /v1/flags

Experiment management

  • Read

    List deployments

    Fetch a list of deployments that experiments or flags can be assigned to.

    GET /api/1/deployments

  • Read

    List experiments

    Fetch a list of experiments and their configuration details. Results are ordered with the most recently created items first.

    GET /api/1/experiments

  • Read

    Get experiment

    Fetch the configuration details of an experiment.

    GET /api/1/experiments/{id}

  • Read

    List versions (experiment)

    Fetch a list of all versions for an experiment.

    GET /api/1/experiments/{id}/versions

  • Read

    Get version details (experiment)

    Fetch details of a specific version of an experiment.

    GET /api/1/experiments/{id}/versions/{versionId}

  • Read

    List variants (experiment)

    Fetch a list of all variants for an experiment.

    GET /api/1/experiments/{id}/variants

  • Read

    Get variant details (experiment)

    Fetch details of a specific variant of an experiment.

    GET /api/1/experiments/{id}/variants/{variantKey}

  • Read

    Get variant inclusions (experiment)

    Fetch a list of inclusions for a specific variant of an experiment.

    GET /api/1/experiments/{id}/variants/{variantKey}/users

  • Read

    Get variant cohort inclusions (experiment)

    Fetch a list of cohort inclusions for a specific variant of an experiment.

    GET /api/1/experiments/{id}/variants/{variantKey}/cohorts

  • Read

    List deployments (experiment)

    List all deployments for an experiment.

    GET /api/1/experiments/{id}/deployments

  • Read

    List flags

    Fetch a list of flags including their configuration details. Results are ordered with the most recently created items first.

    GET /api/1/flags

  • Read

    Get flag

    Fetch the configuration details of a flag.

    GET /api/1/flags/{id}

  • Read

    List versions (flag)

    Fetch a list of all versions for a flag.

    GET /api/1/flags/{id}/versions

  • Read

    Get version details (flag)

    Fetch details of a specific version of a flag.

    GET /api/1/flags/{id}/versions/{versionId}

  • Read

    List variants (flag)

    Fetch a list of all variants for a flag.

    GET /api/1/flags/{id}/variants

  • Read

    Get variant details (flag)

    Fetch details of a specific variant of a flag.

    GET /api/1/flags/{id}/variants/{variantKey}

  • Read

    Get variant inclusions (flag)

    Fetch a list of inclusions for a specific variant of a flag.

    GET /api/1/flags/{id}/variants/{variantKey}/users

  • Read

    Get variant cohort inclusions (flag)

    Fetch a list of cohort inclusions for a specific variant of a flag.

    GET /api/1/flags/{id}/variants/{variantKey}/cohorts

  • Read

    List deployments (flag)

    List all deployments for a flag.

    GET /api/1/flags/{id}/deployments

  • Read

    List holdout groups

    Fetch a list of holdout groups including their configuration details.

    GET /api/1/holdouts

  • Read

    Get holdout group

    Fetch the configuration details of a holdout group.

    GET /api/1/holdouts/{id}

  • Read

    List mutex groups

    Fetch a list of mutex groups including their configuration details.

    GET /api/1/mutexes

  • Read

    Get mutex group

    Fetch the configuration details of a mutex group.

    GET /api/1/mutexes/{id}

  • Read

    List versions

    Fetch a list of versions for all experiments or flags that the management API key can access. The list spans multiple projects when the key scope includes them.

    GET /api/1/versions

  • Write

    Create deployment

    Create a deployment that experiments or flags can be assigned to.

    POST /api/1/deployments

  • Write

    Edit deployment

    Updates an existing deployment.

    PATCH /api/1/deployments/{id}

  • Write

    Create variant (experiment)

    Create a new variant for an experiment.

    POST /api/1/experiments/{id}/variants

  • Write

    Edit variant (experiment)

    Updates an existing variant (experiment).

    PATCH /api/1/experiments/{id}/variants/{variantKey}

  • Write

    Add users to variant (experiment)

    Add inclusions (users or devices) to the experiment's variant.

    POST /api/1/experiments/{id}/variants/{variantKey}/users

  • Write

    Add cohorts to variant (experiment)

    Add cohort inclusions to the experiment's variant.

    POST /api/1/experiments/{id}/variants/{variantKey}/cohorts

  • Write

    Add deployment (experiment)

    Add a deployment to an experiment.

    POST /api/1/experiments/{id}/deployments

  • Write

    Edit experiment

    Updates an existing experiment.

    PATCH /api/1/experiments/{id}

  • Write

    Create experiment

    Create a new feature experiment.

    POST /api/1/experiments

  • Write

    Create variant (flag)

    Create a new variant for a flag

    POST /api/1/flags/{id}/variants

  • Write

    Edit variant (flag)

    Edit a variant for a flag.

    POST /api/1/flags/{id}/variants/{variantKey}

  • Write

    Add users to variant (flag)

    Add inclusions (users or devices) to a flag's variant.

    POST /api/1/flags/{id}/variants/{variantKey}/users

  • Write

    Add cohorts to variant (flag)

    Add cohort inclusions to a flag's variant.

    POST /api/1/flags/{id}/variants/{variantKey}/cohorts

  • Write

    Create deployment (flag)

    Add a deployment for a flag.

    POST /api/1/flags/{id}/deployments

  • Write

    Edit flag

    Updates an existing flag.

    PATCH /api/1/flags/{id}

  • Write

    Create flag

    Create a new flag.

    POST /api/1/flags

  • Write

    Edit holdout group

    Updates an existing holdout group.

    PATCH /api/1/holdouts/{id}

  • Write

    Create holdout group

    Create a new holdout group.

    POST /api/1/holdouts

  • Write

    Edit mutex group

    Updates an existing mutex group.

    PATCH /api/1/mutexes/{id}

  • Write

    Edit mutex group Slots

    Updates an existing mutex group slots.

    PATCH /api/1/mutexes/{id}/slots/{slotIndex}

  • Write

    Create mutex group

    Create a new mutex group.

    POST /api/1/mutexes

  • Destructive

    Remove variant (experiment)

    Updates an existing remove variant (experiment).

    DELETE /api/1/experiments/{id}/variants/{variantKey}

  • Destructive

    Remove users from variant (experiment)

    Updates an existing remove users from variant (experiment).

    DELETE /api/1/experiments/{id}/variants/{variantKey}/users/{userIndex}

  • Destructive

    Remove all users from variant (experiment)

    Updates an existing remove all users from variant (experiment).

    DELETE /api/1/experiments/{id}/variants/{variantKey}/users

  • Destructive

    Bulk remove users from variant (experiment)

    Updates an existing bulk remove users from variant (experiment).

    DELETE /api/1/experiments/{id}/variants/{variantKey}/bulk-delete-users

  • Destructive

    Bulk remove cohorts from variant (experiment)

    Updates an existing bulk remove cohorts from variant (experiment).

    DELETE /api/1/experiments/{id}/variants/{variantKey}/bulk-delete-cohorts

  • Destructive

    Remove deployment (experiment)

    Updates an existing remove deployment (experiment).

    DELETE /api/1/experiments/{id}/deployments/{deploymentId}

  • Destructive

    Remove variant (flag)

    Updates an existing remove variant (flag).

    DELETE /api/1/flags/{id}/variants/{variantKey}

  • Destructive

    Remove users from variant (flag)

    Updates an existing remove users from variant (flag).

    DELETE /api/1/flags/{id}/variants/{variantKey}/users/{userIndex}

  • Destructive

    Remove all users from variant (flag)

    Updates an existing remove all users from variant (flag).

    DELETE /api/1/flags/{id}/variants/{variantKey}/users

  • Destructive

    Bulk remove users from variant (flag)

    Updates an existing bulk remove users from variant (flag).

    DELETE /api/1/flags/{id}/variants/{variantKey}/bulk-delete-users

  • Destructive

    Bulk remove cohorts from variant (flag)

    Updates an existing bulk remove cohorts from variant (flag).

    DELETE /api/1/flags/{id}/variants/{variantKey}/bulk-delete-cohorts

  • Destructive

    Remove deployment (flag)

    Updates an existing remove deployment (flag).

    DELETE /api/1/flags/{id}/deployments/{deploymentId}

User management

  • Read

    Get project effective access

    Returns the resolved access list for a project: which users and groups have access, which role applies, and how that access was granted.

    GET /user-management/1/projects/{projectId}/access

  • Read

    Get user effective access

    Returns the resolved project access for a user, including access granted directly, via groups, and via organization-level grants.

    GET /user-management/1/users/{userId}/effective-access

  • Read

    List group members

    Returns a paginated list of user ids in a permission group in the caller's organization.

    GET /user-management/1/groups/{groupId}/members

  • Read

    List groups

    Returns a paginated list of permission groups for the caller's organization. Soft-deleted groups are omitted.

    GET /user-management/1/groups

  • Read

    Get project role assignment

    Returns a single explicit project role assignment by assignment id.

    GET /user-management/1/project-role-assignments/{assignmentId}

  • Read

    List project role assignments

    Returns a paginated list of explicit project role assignments for the caller's organization. Optional filters: principalId, projectId, and roleId.

    GET /user-management/1/project-role-assignments

  • Read

    Get role

    Returns a single role definition by role uuid. The response omits permission actions.

    GET /user-management/1/roles/{roleId}

  • Read

    List roles

    Returns a paginated list of role definitions for the caller's organization. Role responses omit permission actions.

    GET /user-management/1/roles

  • Write

    Add group member

    Adds a user to a permission group in the caller organization.

    POST /user-management/1/groups/{groupId}/members/{userId}

  • Write

    Create project role assignment

    Grants a user or group an explicit role on a project. Returns 409 if that principal already has an explicit assignment on the project.

    POST /user-management/1/project-role-assignments

  • Write

    Update project role assignment

    Updates the role on an existing project role assignment. The principal and project are immutable; only roleId can change.

    PATCH /user-management/1/project-role-assignments/{assignmentId}

  • Destructive

    Remove group member

    Removes a user from a permission group in the caller organization.

    DELETE /user-management/1/groups/{groupId}/members/{userId}

  • Destructive

    Delete project role assignment

    Deletes a single explicit project role assignment by assignment id.

    DELETE /user-management/1/project-role-assignments/{assignmentId}

Guides and surveys

  • Read

    Export guide and survey translations

    Downloads guide and survey text as XLIFF files for translation.

    GET /a/guides-surveys/api/v1/localization/export

  • Write

    Import guide and survey translations

    Uploads XLIFF translation files for guides and surveys.

    POST /a/guides-surveys/api/v1/localization/import

Get started

  1. Open Space settings → Connections and search for Amplitude.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.