Skip to content

Commit 12c8a92

Browse files
committed
Document the includeUtm configuration flag in README
1 parent 56af796 commit 12c8a92

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,14 @@ You can configure Amplitude by passing an object as the third argument to the `i
6464

6565
amplitude.init("YOUR_API_KEY_HERE", null, {
6666
// optional configuration options
67-
saveEvents: true
67+
saveEvents: true,
68+
includeUtm: true
6869
})
6970

7071
| option | description | default |
7172
|------------|----------------------------------------------------------------------------------|-----------|
7273
| saveEvents | If `true`, saves events to localStorage and removes them upon successful upload.<br><i>NOTE:</i> Without saving events, events may be lost if the user navigates to another page before events are uploaded. | `true` |
74+
| includeUtm | If `true`, finds utm parameters in the query string or the __utmz cookie, parses, and includes them as user propeties on all events uploaded. | `false` |
7375

7476

7577
# Advanced #

0 commit comments

Comments
 (0)