Skip to content

Commit cfbb46e

Browse files
authored
changes to property names making it json friendly
1 parent d896b92 commit cfbb46e

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The `identify` lets you tie a user to their actions and record traits about them
4747
Example `user` call:
4848
```
4949
track.user(
50-
user_id="<user_id in your db>",
50+
userId="<user_id in your db>",
5151
traits={
5252
"name": "John Doe",
5353
"email": "john@email.com",
@@ -58,15 +58,15 @@ track.user(
5858
#### The `user` call has the following fields:
5959
|Field|Data type|Description|
6060
|--|--|--|
61-
|user_id|str or int|The ID for the user in your database.|
62-
|country_code|str|country code for the phone_number (default value is "+91")|
63-
|phone_number|str|phone_number without country_code (eg: "9876598765")|
61+
|userId|str or int|The ID for the user in your database.|
62+
|countryCode|str|country code for the phone_number (default value is "+91")|
63+
|phoneNumber|str|phone_number without country_code (eg: "9876598765")|
6464
|traits|dict|A dict of traits you know about the user. Things like: `email`, `name` or `age`|
6565

6666
**NOTE:** Atleast one of these two is required for user identification :
6767

68-
- **user_id**, OR
69-
- **phone_number** with **country_code**
68+
- **userId**, OR
69+
- **phoneNumber** with **countryCode**
7070

7171

7272

@@ -76,7 +76,7 @@ track.user(
7676
Example `event` call:
7777
```
7878
track.event(
79-
user_id="<user_id in your db>",
79+
userId="<user id in your db>",
8080
event="Product Added",
8181
traits={"price": 200}
8282
)
@@ -85,6 +85,6 @@ track.event(
8585

8686
|Field|Data type|Description|
8787
|--|--|--|
88-
|user_id|str or int|The ID for the user in your database.|
88+
|userId|str or int|The ID for the user in your database.|
8989
|event|str|Name of the event you want to track, For eg: "Product Added".|
9090
|traits|dict|dictionary of properties for the event. If the event was **Product Added**, it might have properties like `price` or `product_name`.|

0 commit comments

Comments
 (0)