Amplitude Integration

Field	Description	Required	Format
API Key	Amplitude project API Key (used for event tracking and Dashboard Basic auth).	Yes	`-`
Secret Key	Amplitude project Secret Key (required for Dashboard REST API and User Profile queries).	No	`-`

send_event — Track an event in Amplitude using the HTTP V2 API.

Parameters

string

required

Name of the event (e.g., “page_view”, “purchase”).

string

User ID (required if no device_id).

string

Device ID (required if no user_id).

object

Custom event properties as a JSON object.

object

User properties to set (supports

set,

setOnce,

add,

append, $unset).

integer

Event timestamp in milliseconds since epoch.

integer

Session start time in milliseconds since epoch (-1 for no session).

string

Unique ID for deduplication (within a 7-day window).

string

Application version string.

string

Platform (e.g., “Web”, “iOS”, “Android”).

string

Two-letter country code.

string

Language code (e.g., “en”).

string

IP address for geo-location (use “$remote” for request IP).

number

Price of the item purchased.

integer

Quantity of items purchased.

number

Revenue amount.

string

Product identifier.

string

Revenue type (e.g., “purchase”, “refund”).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Code"
    },
    "events_ingested": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Events Ingested"
    },
    "payload_size_bytes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Payload Size Bytes"
    },
    "server_upload_time": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Server Upload Time"
    }
  },
  "required": [
    "success"
  ],
  "title": "SendEventOutput",
  "type": "object"
}

identify_user — Set user properties in Amplitude using the Identify API. Supports $set, $setOnce, $add, $append, $unset operations.

Parameters

object

required

User properties to set. Use operations like

set,

setOnce,

add,

append, $unset.

string

User ID (required if no device_id).

string

Device ID (required if no user_id).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Code"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "IdentifyUserOutput",
  "type": "object"
}

group_identify — Set group-level properties in Amplitude. Supports $set, $setOnce, $add, $append, $unset operations.

Parameters

string

required

Group classification (e.g., “company”, “org_id”).

string

required

Specific group identifier (e.g., “Acme Corp”).

object

required

Group properties as a JSON object. Use operations like

set,

setOnce,

add,

append, $unset.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Code"
    },
    "message": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Message"
    }
  },
  "required": [
    "success"
  ],
  "title": "GroupIdentifyOutput",
  "type": "object"
}

user_search — Search for a user by User ID, Device ID, or Amplitude ID using the Dashboard REST API.

Parameters

string

required

User ID, Device ID, or Amplitude ID to search for.

Response

{
  "$defs": {
    "UserSearchMatch": {
      "additionalProperties": false,
      "description": "A single user-search match entry.",
      "properties": {
        "amplitude_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Amplitude Id"
        },
        "user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User Id"
        }
      },
      "title": "UserSearchMatch",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "matches": {
      "items": {
        "$ref": "#/$defs/UserSearchMatch"
      },
      "title": "Matches",
      "type": "array"
    },
    "type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    }
  },
  "required": [
    "success"
  ],
  "title": "UserSearchOutput",
  "type": "object"
}

user_activity — Get the event stream for a specific user by their Amplitude ID.

Parameters

string

required

Amplitude internal user ID.

integer

Offset for pagination (default 0).

integer

Maximum number of events to return (default 1000, max 1000).

string

Sort direction: “latest” or “earliest” (default: latest).

Response

{
  "$defs": {
    "UserActivityEvent": {
      "additionalProperties": false,
      "description": "A single event in a user's activity stream.",
      "properties": {
        "event_type": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Event Type"
        },
        "event_time": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Event Time"
        },
        "event_properties": {
          "additionalProperties": true,
          "title": "Event Properties",
          "type": "object"
        },
        "user_properties": {
          "additionalProperties": true,
          "title": "User Properties",
          "type": "object"
        },
        "session_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Session Id"
        },
        "platform": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Platform"
        },
        "country": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Country"
        },
        "city": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "City"
        }
      },
      "title": "UserActivityEvent",
      "type": "object"
    },
    "UserData": {
      "additionalProperties": false,
      "description": "User metadata returned alongside an activity stream.",
      "properties": {
        "user_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "User Id"
        },
        "canonical_amplitude_id": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Canonical Amplitude Id"
        },
        "num_events": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Num Events"
        },
        "num_sessions": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Num Sessions"
        },
        "platform": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Platform"
        },
        "country": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Country"
        }
      },
      "title": "UserData",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "events": {
      "items": {
        "$ref": "#/$defs/UserActivityEvent"
      },
      "title": "Events",
      "type": "array"
    },
    "user_data": {
      "anyOf": [
        {
          "$ref": "#/$defs/UserData"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "UserActivityOutput",
  "type": "object"
}

user_profile — Get a user profile including properties, cohort memberships, and computed properties.

Parameters

string

External user ID (required if no device_id).

string

Device ID (required if no user_id).

boolean

Include Amplitude user properties (default: false). (Default: false)

boolean

Include cohort IDs the user belongs to (default: false). (Default: false)

boolean

Include computed user properties (default: false). (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "user_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "User Id"
    },
    "device_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Device Id"
    },
    "amp_props": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Amp Props"
    },
    "cohort_ids": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cohort Ids"
    },
    "computations": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Computations"
    }
  },
  "required": [
    "success"
  ],
  "title": "UserProfileOutput",
  "type": "object"
}

event_segmentation — Query event analytics data with segmentation. Get event counts, uniques, averages, and more.

Parameters

string

required

Event type name to analyze.

string

required

Start date in YYYYMMDD format.

string

required

End date in YYYYMMDD format.

string

Metric type: uniques, totals, pct_dau, average, histogram, sums, value_avg, or formula (default: uniques).

string

Time interval: 1 (daily), 7 (weekly), or 30 (monthly).

string

Property name to group by (prefix custom user properties with “gp:”).

integer

Maximum number of group-by values (max 1000).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "series": {
      "items": {},
      "title": "Series",
      "type": "array"
    },
    "series_labels": {
      "items": {},
      "title": "Series Labels",
      "type": "array"
    },
    "series_collapsed": {
      "items": {},
      "title": "Series Collapsed",
      "type": "array"
    },
    "x_values": {
      "items": {
        "type": "string"
      },
      "title": "X Values",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "EventSegmentationOutput",
  "type": "object"
}

get_active_users — Get active or new user counts over a date range from the Dashboard REST API.

Parameters

string

required

Start date in YYYYMMDD format.

string

required

End date in YYYYMMDD format.

string

Metric type: “active” or “new” (default: active).

string

Time interval: 1 (daily), 7 (weekly), or 30 (monthly).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "series": {
      "items": {},
      "title": "Series",
      "type": "array"
    },
    "series_meta": {
      "items": {
        "type": "string"
      },
      "title": "Series Meta",
      "type": "array"
    },
    "x_values": {
      "items": {
        "type": "string"
      },
      "title": "X Values",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetActiveUsersOutput",
  "type": "object"
}

realtime_active_users — Get real-time active user counts at 5-minute granularity for the last 2 days.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "series": {
      "items": {},
      "title": "Series",
      "type": "array"
    },
    "series_labels": {
      "items": {
        "type": "string"
      },
      "title": "Series Labels",
      "type": "array"
    },
    "x_values": {
      "items": {
        "type": "string"
      },
      "title": "X Values",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "RealtimeActiveUsersOutput",
  "type": "object"
}

list_events — List all event types in the project with their weekly totals and unique counts.

Response

{
  "$defs": {
    "ProjectEvent": {
      "additionalProperties": false,
      "description": "A single event type listed for the project.",
      "properties": {
        "value": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Value"
        },
        "display_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Display Name"
        },
        "totals": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Totals"
        },
        "hidden": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Hidden"
        },
        "deleted": {
          "anyOf": [
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Deleted"
        }
      },
      "title": "ProjectEvent",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "events": {
      "items": {
        "$ref": "#/$defs/ProjectEvent"
      },
      "title": "Events",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListEventsOutput",
  "type": "object"
}

get_revenue — Get revenue LTV data including ARPU, ARPPU, total revenue, and paying user counts.

Parameters

string

required

Start date in YYYYMMDD format.

string

required

End date in YYYYMMDD format.

string

Metric: 0 (ARPU), 1 (ARPPU), 2 (Total Revenue), 3 (Paying Users).

string

Time interval: 1 (daily), 7 (weekly), or 30 (monthly).

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "series": {
      "items": {},
      "title": "Series",
      "type": "array"
    },
    "series_labels": {
      "items": {
        "type": "string"
      },
      "title": "Series Labels",
      "type": "array"
    },
    "x_values": {
      "items": {
        "type": "string"
      },
      "title": "X Values",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetRevenueOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Amplitude Integration for AI Agents & Workflows

Overview

Authentication

Amplitude API Key + Secret Key

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Response

Parameters

Response

Limits & Quotas

Google Analytics

Google Tag Manager

Mixpanel

Links

​Overview

​Authentication

​Amplitude API Key + Secret Key

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Google Analytics

Google Tag Manager

Mixpanel

​Links

Overview

Authentication

Amplitude API Key + Secret Key

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Response

Parameters

Response

Limits & Quotas

Related integrations

Links