Basic introduction
This section contains APIs for various capabilities powered by "targets" in the system. The following are the capabilities that are currently being powered by targets:
- Milestones
- Single milestone: Contains only 1 target
- Unified milestone: Contains more than 1 target & they are linked together with arithmetic operations like:
- ALL: Works similar to AND
- ANY (N-1): Words identical to OR
- Streaks
- Cappings (Individual customer type of capping)
- User-created challenges
- These are similar to single milestones but can be created by the end-user directly from the mobile app instead of the brand creating them via CRM for their end-users. In this case, the word 'challenge' is analogous to 'milestone'.
Good to know information:
To know how the target (and its downstream capabilities) works, it is advised to know about the following nuances for better & enhanced understanding. Following are the 4 major components involved here:
-
Target group
- This is like a container (or a bowl) that can hold one/more target rules in it.
- This will have core properties associated with it like:
- Tracking type: Defines what is the nature of the tracking
- Single
- Unified
- Streak
- Capping
- Start & End date on a whole
- Frequency
- The number of periods/cycles, etc...
- Tracking type: Defines what is the nature of the tracking
-
Periods/Cycle
- This will have information on the timelines within which the tracking will happen.
- Will have the exact start & end date for each cycle of the target group.
- If the frequency & number of cycles are given as weekly, 3 in the target group level info, then this contains what is the exact start & end date for all the 3 cycles:
- 1st cycle: Start date (point a) - End date (point b)
- 2nd cycle: Start date (point b) - End date (point c)
- 3rd cycle: Start date (point c) - End date (point d)
- A few points to note here are:
- The start date given in the target group (point x) should always be <= 1st cycle's start date (point a)
- The end date given in the target group (point y) should always be >= Last cycle's end date (point d)
- No tracking will happen between point (x, a) & point (d, y). Tracking will always happen within cycles.
- This will have information on the timelines within which the tracking will happen.
-
Target rule (some call this as the target itself)
-
This contains information on what to track exactly
- KPI to be tracked
- Target value
- Filters, etc...
-
Depending on the tracking type of target group, a single target group can have 1 target or multiple targets
-
Capability How many target groups How many target rules Single milestone 1 1 Unified milestone 1 more than 1 Streak 1 1 Capping 1 1 User-created challenges 1 1
-
No matter how many target rules are present in a target group, all of them will have the same period/cycle information. For instance, even though more than 1 target is present in unified target milestones, all the targets are tracked in similar timelines.
- This means that, period/cycle is associated with 'target group' but not 'target rule'.
-
-
-
Streak
- When the tracking type is mentioned as 'streak' in the target group info, then this extra information will also need to be added to the payload.
- This essentially contains information on how many continuous/non-continuous periods the user has to achieve to get the rewards.