SendEvents
Used to send events data to Amplitude
Input
Name | Type | Description |
UserId | String | A readable ID specified by you. Must have a minimum length of 5 characters. Required unless device_id is present. |
DeviceId | String | A device-specific identifier, such as the Identifier for Vendor on iOS. Required unless user_id is present. If a device_id is not sent with the event, it will be set to a hashed version of the user_id. |
EventType | String | A unique identifier for your event. |
Time | String | The timestamp of the event in milliseconds since epoch. If time is not sent with the event, it will be set to the request upload time. |
EventProperties | String | A JSON object that contains a dictionary of key-value pairs that represent additional data tied to the user. See Amplitude API documentation for an example: https://developers.amplitude.com/?http#http-api-v2-request-format. |
UserProperties | String | A JSON object that contains a dictionary of key-value pairs that represent additional data tied to the user. See Amplitude API documentation for an example: https://developers.amplitude.com/?http#http-api-v2-request-format. |
Groups | String | This feature is only available to Enterprise customers who have purchased the Accounts add-on.A JSON object that contains a dictionary of key-value pairs that represent groups of users to the event as an event-level group. You can only track up to 5 groups. See Amplitude API documentation for an example: https://developers.amplitude.com/?http#http-api-v2-request-format. |
AppVersion | String | The current version of your application. |
Platform | String | Platform of the device. |
OsName | String | The name of the mobile operating system or browser that the user is using. |
OsVersion | String | The version of the mobile operating system or browser the user is using. |
DeviceBrand | String | The device brand that the user is using. |
DeviceManufacturer | String | The device manufacturer that the user is using. |
DeviceModel | String | The device model that the user is using. |
Carrier | String | The carrier that the user is using. |
Country | String | The current country of the user. |
Region | String | The current region of the user. |
City | String | The current city of the user. |
Dma | String | The current Designated Market Area of the user. |
Language | String | The Language of the user. |
Price | String | The price of the item purchased. Required for revenue data if the revenue field is not sent. You can use negative values to indicate refunds. |
Quantity | String | The quantity of the item purchased. Defaults to 1 if not specified. |
Revenue | String | Revenue = price * quantity. If you send all 3 fields of price, quantity, and revenue, then (price * quantity) will be used as the revenue value. You can use negative values to indicate refunds. |
ProductId | String | An identifier for the item purchased. You must send a price and quantity or revenue with this field. |
RevenueType | String | The type of revenue for the item purchased. You must send a price and quantity or revenue with this field. |
LocationLat | String | The current Latitude of the user. |
LocationLng | String | The current Longitude of the user. |
Ip | String | The IP address of the user. Use |
Idfa | String | (iOS) Identifier for Advertiser. |
Idfv | String | (iOS) Identifier for Vendor. |
Adid | String | (Android) Google Play Services advertising ID |
AndroidId | String | (Android) Android ID (not the advertising ID) |
EventId | String | (Optional) An incrementing counter to distinguish events with the same user_id and timestamp from each other. We recommend you send an EventId, increasing over time, especially if you expect events to occur simultanenously. |
SessionId | String | (Optional) The start time of the session in milliseconds since epoch (Unix Timestamp), necessary if you want to associate events with a particular system. A session_id of -1 is the same as no session_id specified. |
InsertId | String | (Optional) A unique identifier for the event. We will deduplicate subsequent events sent with an insert_id we have already seen before within the past 7 days. We recommend generation a UUID or using some combination of DeviceId, UserId, EventType, EventId, and Time. |
MinIdLength | String | Minimum permitted length for UserId & DeviceId fields |
Result Set Columns
Name | Type | Description |
Code | String | |
ServerUploadTime | String | |
EventsIngested | String | |
PayloadSizeBytes | String |