Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

get/activities/{id}

Response

200

enduser_activity_short_descriptionstring

"Description" configuration in Zinrelo admin console.

activity_idstring

The unique ID of the activity assigned by Zinrelo.

show_on_guest_dashboardboolean

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_htmlstring

"Points earning description HTML" configuration in Zinrelo admin console.

activity_card_background_image_urlstring

"Activity Tile Image" configuration in Zinrelo admin console.

is_qualified_for_tier_upgradeboolean

The activity qualifies for a tier upgrade. 

last_modified_datestring

The most recent date on which a transaction was updated.

is_activeboolean

This reflects the status of the activity, indicating if it's active or inactive.

approval_methodstring

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_datestring

The date and time on which the transaction was created.

activity_namestring

The activity name stored with Zinrelo.

is_points_expiry_reset_activityboolean

The activity which resets expiry. To check and configure it, navigate to Program Settings>> Points Expiration.

{"stackTrail":"components:schemas:retrieve-an-activity-with-zinrelo-generated-id-response1-object:properties:metadata","oasType":"schema","type":"unknown","description":"The metadata associated with an activity."}
idstring

The internal ID generated by Zinrelo.

activity_benefit_typestring

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.

Example response

{
  "points_config": {
    "points_computation_type": "multiplier_based",
    "attribute_to_multiply": "order_subtotal",
    "multiplier": 1
  },
  "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.",
  "activity_id": "made_a_purchase",
  "show_on_guest_dashboard": true,
  "enduser_activity_description_html": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>My Page</title>\n</head>\n<body>\n\t<h1>Welcome to my page!</h1>\n</body>\n</html>",
  "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
  "is_qualified_for_tier_upgrade": true,
  "last_modified_date": "2023-03-13 07:28:02.766000",
  "is_active": true,
  "rules_config": [
    {
      "rule_type": "Fixed Points",
      "is_archived": false,
      "is_active": false,
      "conditions_matching_policy": "match_all",
      "rule_name": "",
      "conditions": [
        {
          "operator": "Between",
          "attribute": "Transaction Date",
          "value": "3/6/2023-3/29/2023"
        }
      ],
      "rule_value": 100
    }
  ],
  "approval_method": "immediate",
  "created_date": "2022-12-09 08:20:38.475000",
  "activity_name": "Purchase on website",
  "is_points_expiry_reset_activity": true,
  "metadata": {
    "Brand": "Nescafe",
    "Location": "London"
  },
  "id": "6392efd671891b0009b5a736",
  "activity_benefit_type": "points",
  "success": true
}