Root definitions

HistoryCriteria

Permalink

Criteria will only trigger if ALL present thresholds (comment, submission, total) are met

Properties

comment

string

A string containing a comparison operator and a value to compare filtered (using include or exclude, if present) comments against

The syntax is (< OR > OR <= OR >=) <number>[percent sign] [OP]

  • EX > 100 => greater than 100 comments
  • EX <= 75% => comments are equal to or less than 75% of unfiltered Activities

If your string also contains the text OP somewhere after <number>[percent sign]...:

  • EX > 100 OP => greater than 100 filtered comments as OP
  • EX <= 25% as OP => Filtered comments as OP were less then or equal to 25% of unfiltered Comments
Pattern: ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
minActivityCount

number

The minimum number of filtered activities that must exist from the window results for this criteria to run

Default: 5
name

string

ratio

ratio

submission

string

A string containing a comparison operator and a value to compare filtered (using include or exclude, if present) submissions against

The syntax is (< OR > OR <= OR >=) <number>[percent sign]

  • EX > 100 => greater than 100 filtered submissions
  • EX <= 75% => filtered submissions are equal to or less than 75% of unfiltered Activities
Pattern: ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
total

string

A string containing a comparison operator and a value to compare filtered (using include or exclude) activities against

Note: This is only useful if using include or exclude otherwise percent will always be 100% and total === activityTotal

The syntax is (< OR > OR <= OR >=) <number>[percent sign] [OP]

  • EX > 100 => greater than 100 filtered activities
  • EX <= 75% => filtered activities are equal to or less than 75% of all Activities
Pattern: ^\s*(>|>=|<|<=)\s*(\d+)\s*(%?)(.*)$
window Required

anyOf [DurationObject, FullActivityWindowConfig, string ∪ number]

A value to define the range of Activities to retrieve.

Acceptable values:

ActivityWindowCriteria object

Allows specify multiple range properties and more specific behavior

A number of Activities to retrieve

  • EX 100 => 100 Activities

Any of the below values that specify the amount of time to subtract from NOW to create a time range IE NOW <---> [duration] ago

Acceptable values:

A string consisting of a value and a Day.js time UNIT

  • EX 9 days => Range is NOW <---> 9 days ago

A Day.js object

  • EX {"days": 90, "minutes": 15} => Range is NOW <---> 90 days and 15 minutes ago

An ISO 8601 duration string

  • EX PT15M => 15 minutes => Range is NOW <----> 15 minutes ago
Loading...

Editor and Validator