UNPKG

@financial-times/o-tracking

Version:

Provides tracking for a product. Tracking requests are sent to the Spoor API.

121 lines (72 loc) 2.09 kB
# comment:recommend A comment:recommend event is sent on any click that would result in the recommending of a comment. --------- These are the documented parameters for a comment:recommend 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: `recommend` - 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: `recommend' - o-tracking automatic: no - spoor pipeline automatic: no ### 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 the root of a thread. Two values: 1. Event is a reply: `1` 2. Event is the root of a thread `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