Connect
In order to track your user activities on websites; or to update your user profiles on Read/See, we recommend you to use our tracker that you can read here. But we also provide Software Development Kit (SDK) if you need to. Learn how to generate the token & connect with our SDK to track, update your profile properties or your event properties.
APIs
The current version of the API lives at https://api.readsee.io/v1
Endpoints
Method | Endpoint | What it does |
---|---|---|
POST | track/profile | Update profile properties |
POST | track/event | Update event properties |
How to use Read/See Global SDK
Generate the token, after you get the token by clicking Add Source in Global SDK menu on app, you can use the token as credentials to update the event or profiles
- Sending updates using SDK is very easy. You can use HTTP POST that leads to SDK URL API.
- Sending Update Profile Properties
POST /track/profile
HEADER Bearer Auth = token/ id SDK
Body :
{
"_$anonymous_id": "", //REQUIRED, SEND BY SYSTEM
"_$distinct_id": "", //REQUIRED, SEND BY SYSTEM, CAN BE SENT IF WANNA CHANGE DISTINCTID
"_$email": "",
"_$first_name": "",
"_$last_name": "",
"_$phone": "",
"_$city": "",
"_$country": "",
"_$address": "",
"_$device_id": "",
"custom_props_text": "",
"custom_props_number": 212,
"custom_props_date": 1683003631668
}
Response :
{
"_$distinct_id": "", // save to local
"_$anonymous_id": "", // save to local
}
- Sending Update Event Properties
POST /track/event
HEADER Bearer Auth = token/ id SDK
Body : Mark with 'api' configuration dependencies that need embed on the final AAR:
{
"_$distinct_id": "", //REQUIRED, SEND BY SYSTEM
"_$name": "", //REQUIRED
"custom_props_text": "",
"custom_props_number": 212,
"custom_props_date": 1683003631668
}
Response :
{
"_$distinct_id": "", // save to local
"_$anonymous_id": "", // save to local
}
Was this article helpful?