Events For SDK
Events Description
DataSenses show the events that are tracked by the SDK. The events are shown in the Dashboard and can be used to create custom reports and post back to partner.
Required params:
- event_name - Event name in event_list. See the standard events list below. Or you can create custom events.
- event_properties - Properties of the event. See the event properties of each event in the standards events list below. Or you can create custom events with custom properties.
- dev_key - This is the unique key for your app use for SDK integration. You can find it in the tab App Settings in the DataSenses Dashboard.
- client_id - SDK will generate a client_id attached with a device, and client_id will be expired and re-created after 1 year without interacting any behaviour, is an uuid string
- app_instance_id - The unique identifier of your app. This will appear when you integrate DataSenses SDK in your app.
- platform - android/ios/web/mweb
- sdk_version - The DataSenses SDK version. For example, 30501
Optional params:
- user_data - The user data of the user. See the user data params below.
- customer_id - Your user id. This is the unique identifier of your user. Should be a uuid string. Example: 123e4567-e89b-12d3-a456-426614174000
- app_version - This is the current version of your application installed on the user device.
- os_version - The Operating system of the device. For example, 1.0.0
- latitude - The user location identified by the latitude.
- longitude - The user location identified by the longitude.
- network_carrier - The network carrier of the device. For example, AT&T, Vodafone.
- network_type - The network type of the device For example, 4g
- device_model - The device model of the device. For example, iPhone 6
User Data Params
- email - The email of the user.
- phone - The phone number of the user.
- first_name - The first name of the user.
- last_name - The last name of the user.
- user_name - The username of the user.
- gender - The gender of the user.
- dob - The date of birth of the user. For example, 1990-01-01
- country - The country of the user.
Item Params
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| item_id | Yes | string | The ID of the item. | SKU_12345 |
| item_name | No | string | The name of the item. | Running Shoes |
| quantity | Yes | number | The quantity of the item. | 2 |
| affiliation | No | string | The store or affiliation from which this item was bought. | Google Store |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| discount | No | number | The discount amount of the item. | 10 |
| index | No | number | The index of the item in the list. | 1 |
| item_brand | No | string | The brand of the item. | Nike |
| item_category | No | array | The category of the item. | ["Shoes", "Running"] |
| item_list_id | No | string | The ID of the list the item was in. | related_products |
| item_list_name | No | string | The name of the list the item was in. | Related Products |
| item_variant | No | string | The variant of the item. | Black |
| location_id | No | string | The location ID of the item. | 12345 |
| price | No | number | The price of the item. | 100 |
Standard Events List
This is the list of events that can be tracked by the SDK. Custom events can also be tracked.
add_payment_info
This event signifies a user has submitted their payment information in a checkout process.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| payment_type | No | string | The payment type used in the payment. | credit_card |
| items | No | array | The items purchased. |
add_shipping_info
This event signifies a user has submitted their shipping information in a checkout process.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| shipping_tier | No | string | The shipping tier selected by the user. | express |
| items | Yes | array | The items purchased. |
add_to_cart
This event signifies a user has added an item to their cart.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| items | Yes | array | The items purchased. |
add_to_wishlist
This event signifies a user has added an item to their wishlist.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| items | Yes | array | The items purchased. |
begin_checkout
This event signifies a user has started the checkout process.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| items | Yes | array | The items purchased. |
contact
This event signifies that a user has contacted the support team.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| method | No | string | The method used to contact support. |
customize_product
This event signifies that a user has customized a product.
donate
This event signifies that a user has donated to your cause.
earn_virtual_currency
This event signifies a user has earned virtual currency in a game.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| virtual_currency_name | No | string | The name of the virtual currency. | coins |
| value | No | number | The value of the virtual currency earned. | 100 |
find_location
This event signifies that a user has found a location in your app.
generate_lead
This event measures when a lead has been generated (for example, through a form). Log this to understand the effectiveness of your marketing campaigns and how many customers re-engage with your business after remarketing to the customers.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
install
This event signifies that an app has been installed.
No params required.
join_group
This event signifies a user has joined a group in a social network.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| group_id | No | string | The ID of the group. | 12345 |
level_up
This event signifies a user has leveled up in your app.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| level | No | number | The level the user has achieved. | 10 |
login
This event signifies a user has logged in.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| method | No | string | The method used to log in. |
post_score
This event signifies a user has posted their score in your game. This is a good time to send a push notification.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| score | No | number | The score posted by the user. | 100 |
purchase
This event signifies that an item was purchased by a user. This is an important event to log as it is the main conversion point in many funnels.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| transaction_id | Yes | string | A unique identifier for the transaction. | 1234 |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| shipping | No | number | The shipping cost associated with the transaction. | 5 |
| tax | No | number | The tax amount of the transaction. | 10 |
| items | Yes | array | The items purchased. |
refund
This event signifies a user has been refunded an item.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| transaction_id | Yes | string | A unique identifier for the transaction. | 1234 |
| coupon | No | string | The coupon code used in the payment. | SUMMER_SALE |
| shipping | No | number | The shipping cost associated with the transaction. | 5 |
| tax | No | number | The tax amount of the transaction. | 10 |
| items | Yes | array | The items purchased. |
remove_from_cart
This event signifies a user has removed an item from their cart.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| currency | Yes | string | Currency of the items associated with the event, in 3-letter ISO 4217 format. If you set value then currency is required for revenue metrics to be computed accurately. | USD |
| value | Yes | number | The monetary value of the event. Set value to the sum of (price * quantity) for all items in items. Don't include shipping or tax. value is typically required for meaningful reporting. If you mark the event as a conversion then it's recommended you set value. currency is required if you set value. | 100 |
| items | Yes | array | The items purchased. |
schedule
This event signifies that a user has scheduled an event/appointment.
Event Properties
| Name | Required | Type | Description | Example |
|---|---|---|---|---|
| event_id | No | string | The ID of the event. | 12345 |
| event_name | No | string | The name of the event. | meeting |