Points computation provides information about how the base points for various activities within our program are calculated, encompassing multiple fields within the points config.
For certain activities like 'Share On Facebook' and 'Write a Review' within our program, a fixed set of points is allocated upon completion. In these instances, the points computation type is designated as "fixed." The points configuration includes an additional field specifying the exact number of fixed points awarded upon successful activity completion. For instance:
{
"points": 100,
"points_computation_typ": “fixed_points”
}
Conversely, some activities such as 'Purchase on Website' and 'Submit a Receipt' within our program grant points based on multiples of a particular value. For instance, when a purchase is made on the website, points are awarded in multiples of the order subtotal. This scenario falls under the points computation type "multiplier_based." The points configuration contains a "multiplier" field and attribute, utilized to multiply the awarded points based on the specified value.
{
"multiplier": 2,
“attribute_to_multiply”: “order_subtotal”
"points_computation_type": “multiplier_based”
}
However, certain activities within the program do not provide any points. These instances occur when the benefit type solely involves coupons. In such cases, the points configuration remains empty, rendering points computation unavailable.
- `attribute_to_multiply` string — If points_computation_type is multiplier based then points config will have attribute_to_multiply and multiplier field along with points_computation_type. Attribute to multiply can have different fields based on activity id. For example- - made_a_purchase actvity will have order_subtotal - submit_a_receipt activity will have receipt_order_value For referral activity based on referrer_payoff_type attribute will have different attribute to multiply fields such as: - percent_purchase_points referrer payoff type will have purchase_points - percent_order_value referrer payoff type will have order_value - `multiplier` integer — The digit that will be multiplied. - `enduser_activity_short_description` string — "Description" configuration in Zinrelo admin console. - `activity_id` string — The unique ID of the activity assigned by Zinrelo. - `show_on_guest_dashboard` boolean — This will display the activity to the user dashboard if "Show Activity in User Dashboard" flag is active in the admin cosnole. - `enduser_activity_description_html` string — "Points earning description HTML" configuration in Zinrelo admin console. - `activity_card_background_image_url` string — "Activity Tile Image" configuration in Zinrelo admin console. - `is_qualified_for_tier_upgrade` boolean — The activity qualifies for a tier upgrade. - `last_modified_date` string — The most recent date on which a transaction was updated. - `is_active` boolean — This reflects the status of the activity, indicating if it's active or inactive. - `rules_config` RetrieveAnActivityUsingActivityIdRuleConfigObject[] - `rule_type` string — The rule type options are "bonus multiplier," "fixed points," or "update attributes." You can select these options within the "Add Action" section in the manage rules section in the admin console. - `is_archived` boolean — This indicates whether the rule is archived within manage rule section in the admin console. - `is_active` boolean — This reflects the status of the rule, indicating if it's active or inactive. You can manage this status by using the "Activate" or "Deactivate" button next to rule names in the manage rules section. - `conditions_matching_policy` string — These conditions, established within the "Manage Rules" section in the Activity Settings, offer two matching options: "Match All" or "Match Any." - `rule_name` string — Name of the configured rule. - `conditions` RetrieveAnActivityUsingActivityIdConditionObject[] - `operator` string — These are the operators available, such as "between," "equals," "contain none of," "contain any of," and others. - `attribute` string — This field will appear when the rule type is set to "fixed," "bonus_multiplier," or "update_attributes." It involves member or transaction attributes that can be selected from the "Add new condition" tab within the rule settings. - `value` string — These are the range of the opeartors. - `rule_value` integer — The value set for the rule type varies: it's a multiplier for "bonus multiplier," points for "fixed points," and "0" for "update attributes." - `approval_method` string — The approval type is configured within the admin console under activity settings. It can be set as immediate, after a fixed duration, or manually. - `created_date` string — The date and time on which the transaction was created. - `activity_name` string — The activity name stored with Zinrelo. - `is_points_expiry_reset_activity` boolean — The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration. - `metadata` unknown - `id` string — The internal ID generated by Zinrelo. - `activity_benefit_type` string — Activity benefit type is based on activity_type” - For 'fixed' activity types, the benefit type is 'points.' - For 'fixed and coupon-based' activity types, the benefit type is 'points_and_coupon_code.' - When the activity type is 'bonus_multiplier,' the benefit type is 'points.' - For 'bonus and coupon-based' activity types, the benefit type is 'points_and_coupon_code.' - For 'coupon-based' activity types, the benefit type is 'coupon_based.'" Please Note: For coupon_based activity, the points_config will be empty. - `extra_config` RetrieveAnActivityUsingActivityIdExtraConfigObject - `share_current_page_url` boolean — The shared url for Facebook/ Pinterest. - `pin_post_image` string — The image for a Pinterest post. This can be uploaded through the admin console on the Activity Setting page by using the 'Post Image' feature. - `pin_post_description` string — The description for 'Share on Pinterest' can be set within the admin console by adjusting the text within the 'Post Description' text box. - `business_instagram_username` string — The username of the Instagram user. - `success` boolean ## Other responses - `400` — 400 --- [API](https://skmtc.net/trueloyal/apis/admin-apis.md) · [All operations](https://skmtc.net/trueloyal/apis/admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/trueloyal/admin-apis/versions/c12d3d379897/schema)