Sending Events
To send new events, make a GET request to following API. When you send the request to this API, OnlineSales.ai register events.
Endpoint
GET https://t.o-s.io/appsflyer
Following is the list of all possible query parameters to be passed to above endpoint:
device_id
The unique identifier for the user currently performing the action. Use GAID or IDFA in case of Android or iOS respectively.
Yes
cli_ubid
Client's generated user id. If sent, this takes precedence over device_id Once generated for a user - should be the same for all the api calls.
Yes if device_id is not set
client_id
Identifier for your account. The value will be shared at the time of integration and will be fixed for all API calls.
Yes
event_time
Time of the event. Format : 13 digit epoch. Eg for 7 August 2019 09:57:18 value will be 1565171838000
Yes
event_name
Should be one of viewproduct, viewrestaurant, funnel_add2cart, funnel_salecomplete
Yes
currency
Currency of the product price
Yes
device_brand
Device manufacturer name
No
device_model
Device model number. eg: SM-G313HZ
No
sales
Total amount of purchase (ex: 102.59) without the currency symbol and comma (,). This is the amount which is after discount (i.e. the amount which the customer paid).
Required if the event_name is funnel_salecomplete
No
item_identifier
The order id which is generated and shown to the users on the website / app.
Required if the event_name is funnel_salecomplete
No
sku_id
pipe (|) separated list of sku ids.
Example:
1. event_name = viewproduct then this will be sku_id = M111
2. eventname = funnel_salecomplete i.e. if there are 2 menu items in cart with id M111 & M222 then this will be sku_id=M111|M222
Yes
product_category
The category in which the menu item belongs. This should be a string and should match with the category feed shared with OnlineSales.ai.
No
cust_email_hash
SHA256 of the email of the user performing the action.
No
product_prices
pipe (|) separated list of prices in order of skuids.
Example:
1. eventname = viewproduct then this will only contain price of one product i.e. productprices = 20
2. event_name = funnel_salecomplete
if the prices of are 2 menu items (M111 & M222) are 20 & 50 respectively in cart then this will be product_prices=20|50.
Yes
product_quantities
pipe (|) separated list of quantities in order of skuids.
Example:
1. event_name = viewproduct, then product_quantities = 1
2. event_name = funnel_salecomplete, if the user has selected 2 and 5 quantities of 2 product items (M111 & M222) respectively then this will be product_quantities=2|5.
Yes
Last updated