@financial-times/o-tracking
Version:
Provides tracking for a product. Tracking requests are sent to the Spoor API.
151 lines (93 loc) • 2.77 kB
Markdown
# comment:post
A comment:post event is sent on any click to the a call to action that would allow a user to 'submit a comment'
---------
These are the documented parameters for a comment:post event.
## Required
### system_category
- Key: `category`
- Required: **yes**
- Value: `comment`
- o-tracking automatic: no
- spoor pipeline automatic: no
### system_action
- Key: `action`
- Required: **yes**
- Value: `post`
- o-tracking automatic: no
- spoor pipeline automatic: no
### comment_ID
- Key: `context.comment_ID`
- Required: **yes**
- Value: `<comment ID>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Unique ID for Comment
### thread_ID
- Key: `context.thread_ID`
- Required: **yes**
- Value: `<thread ID>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Unique ID for Thread
### action_type
- Key: `context.action_type`
- Required: **yes**
- Value: `<type of post>`
- o-tracking automatic: no
- spoor pipeline automatic: no
identifies whether the event was for a thread reply of submission of a new comment. Two values:
1. Event is a reply: `reply`
2. Event is the submission of a new thread: `new post`
### is_reply
- Key: `context.is_reply`
- Required: **yes**
- Value: `<Boolean>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Flag's for whether the event was for a thread reply or submission of a new comment. Two values:
1. Event is a reply: `1`
2. Event is the submission of a new thread `0`
### is_success
- Key: `context.is_reply`
- Required: **yes**
- Value: `<Boolean>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Flag's for whether the event was successful
1. Successful: `1`
2. Unscuccessful: `0`
### commentor_name
- Key: `context.commentor_name`
- Required: **yes**
- Value: `<commentor pseudoname>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Pseudoname of commenetor
### character_count
- Key: `context.character_count`
- Required: **yes**
- Value: `<characters in comment>`
- o-tracking automatic: no
- spoor pipeline automatic: no
The number of characters in the comment
### comment_depth
- Key: `context.comment_depth`
- Required: **yes**
- Value: `<Number of comments above the comment acted on - at a page level>`
- o-tracking automatic: no
- spoor pipeline automatic: no
### thread_depth
- Key: `context.thread_depth`
- Required: **yes**
- Value: `<Number of comments above the comment acted on - at a thread level>`
- o-tracking automatic: no
- spoor pipeline automatic: no
### is_followed
- Key: `context.is_followed`
- Required: **yes**
- Value: `<Boolean>`
- o-tracking automatic: no
- spoor pipeline automatic: no
Flag's for whether the user selected to "follow" the posted comment
1. followed: `1`
2. not followed: `0`