Amplitude · Schema
Amplitude Event
Schema for an Amplitude analytics event used in the HTTP V2 API and exported via the Export API. Represents a single user action or system occurrence tracked in Amplitude.
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior
Properties
| Name | Type | Description |
|---|---|---|
| user_id | string | A readable user identifier. Required unless device_id is present. |
| device_id | string | A device-specific identifier. Required unless user_id is present. |
| event_type | string | The name of the event being tracked. |
| time | integer | The timestamp of the event in milliseconds since epoch. |
| event_properties | object | A dictionary of key-value pairs representing properties of the event. |
| user_properties | object | A dictionary of key-value pairs representing properties of the user. Supports set, setOnce, add, append, prepend, unset, and remove operations. |
| groups | object | A dictionary of group type to group name mappings. |
| group_properties | object | A dictionary of key-value pairs representing properties of the group. |
| app_version | string | The version of the application sending the event. |
| platform | string | The platform of the device, such as iOS, Android, or Web. |
| os_name | string | The name of the operating system. |
| os_version | string | The version of the operating system. |
| device_brand | string | The brand of the device. |
| device_manufacturer | string | The manufacturer of the device. |
| device_model | string | The model of the device. |
| carrier | string | The carrier of the device. |
| country | string | The country of the user. |
| region | string | The region or state of the user. |
| city | string | The city of the user. |
| dma | string | The designated market area of the user. |
| language | string | The language setting of the user. |
| price | number | The price of the item purchased in a revenue event. |
| quantity | integer | The quantity of the item purchased. |
| revenue | number | The revenue generated by the event. Use negative values for refunds. |
| productId | string | The identifier for the product in a revenue event. |
| revenueType | string | The type of revenue, such as purchase or refund. |
| location_lat | number | The latitude of the user's location. |
| location_lng | number | The longitude of the user's location. |
| ip | string | The IP address of the user. Use $remote to use the upload request IP. |
| idfa | string | The Identifier for Advertiser (iOS). |
| idfv | string | The Identifier for Vendor (iOS). |
| adid | string | The Google Play Services advertising ID (Android). |
| android_id | string | The Android ID. |
| event_id | integer | An incrementing counter to distinguish events with identical user_id and timestamps. |
| session_id | integer | The start time of the session in milliseconds since epoch. Use -1 for events outside a session. |
| insert_id | string | A unique identifier for deduplication. Amplitude deduplicates events with the same insert_id and device_id or user_id within 7 days. |