Vocabulary
Achievements (Badges)
An achievement is a graphical reward given when a User has performed a certain number of defined tasks. Usually represented as an icon graphic with a name and description.
Points
A numeric reward or currency that can be awarded to a User when they have performed a certain number of defined tasks.
Leaderboard
A leaderboard is a visual ranking of Users based on Points or Achievements earned.
Partner
A Partner represents an account in our system. It represents a specific business or website which is interacting with IActionable’s services and features.
User
A User represents an individual who interacts with your website or service.
Profile
A Profile is the entity which represents the identifier of a User on your website. A User’s Email Address is one type of Profile. The value of the unique identifier for a Profile is also known as the EntityID. A User may have multiple Profiles. Some service calls allow you to pass in an MD5 hash version of the EntityID. This is used when you want to mask the actual value of the identifier so it is not publicly exposed in links or URLs.
Entity ID
A unique value which identifies a specific User interacting with your website. Is the identifier for a Profile which is created to represent your User in the IActionable system. An Entity Type value is required whenever an EntityID is provided in an API call.
Entity Type
A value which describes the type of EntityID provided in a service call.
Examples: Email, Facebook, Twitter, PhoneNumber, OpenID, Anonymous(GUID), Username, Custom
Event
Events represent an action performed by a Profile (User) on your website. They are identified by a value called the EventKey. Only Letters, Numbers and _ are acceptable values.
Example: UploadedPhoto
Attributes
Attributes are additional information about a specific Event which has occurred. Attribute data can be used when creating rules within the IActionable system.
Example: PhotoID=5, Size=Large
Rule
A rule represents a set of conditions and a rewards. Once all the conditions of a rule have been met the rewards will be assigned and other additional actions will be performed.
Condition
A condition is a specific task with a numeric criteria that must be met. Conditions are associated with a specific EventKey and are only evaluated when a User performs an action associated with that EventKey. Conditions can configured to behave like SQL queries. Functions such as Count, GroupBy, Distinct and Sum are supported.
Action
An action is something that is performed when all the conditions of a rule have been met. Rewards such Achievements and Points are two types of actions. Other actions such as Email, WebHook and Notifications will be available soon.
