A Comprehensive Guide
Customer
data Integration
Data for Actionable
Insights
Get Started
Environment variables
base_url:
https://{client_name}.acdp.quantums.com.sa/api
retl_base_url:
https://wrapper-dev.quantums.me:5001/retl
token:
Contact Quantum Engine admin to obtain token
X-Authorization:
Contact Quantum Engine admin to obtain X-Authorization
X-Siteid:
Contact Quantum Engine admin to obtain X-Siteid
Endpoints
Create New Customer
Create a new customer API call to register a new user and begin tracking their actions across all your pages and platforms.
Parameters
POST {{base_url}}/track/v1/customers
{
"local_id" : "",
"email": "",
"name": "",
"interest": "",
"age": "",
"phone": "",
"company_name": "",
"job_position": "",
"profile_photo": "",
}
Register event for customer action
Register for events based on user actions. Choose from preset events or register your own custom event.
Endpoint
POST {{base_url}}/track/v1/customers/{{email}}/events
Register new page view event
{
"name": "{{page URL or page name}}", // for web platform use page URL for Apps use page name
"type": "page"
}
Add to cart request payload
Parameters
{
"name": "add_to_cart",
"type": "event",
"data": {
"cart_id":"",
"product_id": "",
"product_name": "",
"product_quantity": "",
"product_price": ""
}
}
Remove from cart request payload
Parameters
{
"name": "remove_from_cart",
"type": "event",
"data": {
"cart_id":"",
"product_id": "",
"product_name": "",
"product_quantity": "",
"product_price": ""
}
}
Update cart request payload
Parameters
{
"name": "update_cart",
"type": "event",
"data": {
"cart_id":"",
"product_id": "",
"product_name": "",
"product_quantity": "",
"product_price": ""
}
}
Register order request payload
Parameters
{
"name": "order",
"type": "event",
"data": {
"cart_id":"",
"order_id": "",
"payment_method": "",
"total_price": "",
}
}
Register custom event request payload
Parameters
{
"name": "{{your-custom-event-name}}",
"type": "event",
"data": "{{--Your data--}}"
}
Create Device
An Api call to create a new device and register it under a customer
Endpoint
POST {{base_url}}/track/v1/customers/{{email}}/devices
Parameters
{
"device_token": "",
"platform": "", // Android, iOS, web
"attributes": {
"device_os": "", // example "iOS 17"
"device_model": "", // iphone 15
"app_version": "",
"pio_sdk_version": "",
"device_locale": "en_EG",
"push_enabled": , // boolean true or false
"push_token": ""
}
}
English 
Arabic