Sign in

v1

latestOpenAPI 3.0.22026-07-2645239950.4 KB

EUD Guest Activities API

This page will help you get started with Guest Member API.

get/activities

Query parameters

start_cursorinteger

Defaults to 0. This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

countinteger

Defaults to 100. This is a limit on the number of objects to be returned. Count can range between 1 and 1000, and the default is 100.

languagestring

One of the store languages, for example english/ italian/ german, etc.

sort_bystring
<p>The response will contain the activities ordered by the rank configured in the Zinrelo admin console. You can sort the sequence using the following options: <i><strong>"rank", "-rank", "created_date", "-created_date", "last_modified_date" or "-last_modified_date".</i></strong> Additionally, you can combine sorting options, such as <i><strong>"-rank,created_date", "-rank,-created_date", "-rank,-last_modified_date", "-rank,last_modified_date", "rank,created_date", or "rank,-created_date", "rank,-last_modified_date", or "rank,last_modified_date".</i></strong> </p> <p>"-" signifies the latest activity first. </p> <p><strong>Note: If no sorting option is specified, the response will default to the saved rank, which is "rank,-last_modified_date".</p></strong><p>In scenarios where the rank of activities is same, sorting will be based on a second parameter. For example, in "rank,last_modified_date," if the ranks are identical, the sorting will then be determined by the last modified date parameter.</p>

Response

200

totalinteger

The total number of eligible activities.

next_cursorinteger

This is a cursor for use in pagination. start_index is the index that defines your place in the list. For instance, if you make a list request and receive 1000 objects, your subsequent call can include start_index=1001 in order to fetch the next page of the list.

moreboolean

Example response

{
  "total": 16,
  "activities": [
    {
      "points_config": {
        "points_computation_type": "multiplier_based",
        "attribute_to_multiply": "order_subtotal",
        "multiplier": 1
      },
      "activity_id": "made_a_purchase",
      "enduser_activity_description_html": "Earn 100 points for every advisor you talk to.",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": true,
      "last_modified_date": "2023-07-07 04:59:56.825000",
      "metadata": {
        "Category": "Chocolate Cake"
      },
      "enduser_activity_short_description": "Earn points for every dollar you spend in purchases.",
      "created_date": "2021-03-15 12:59:39.818000",
      "activity_name": "Loan Installment Payment",
      "is_points_expiry_reset_activity": true,
      "id": "604f5a3b8152252216f5c19b",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "created_an_account",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-06-14 09:03:33.343000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points when you create your loyalty account.",
      "created_date": "2021-03-15 12:59:39.812000",
      "activity_name": "Account Creation",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c19a",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points_computation_type": "multiplier_based",
        "multiplier": 1
      },
      "activity_id": "write_a_review",
      "enduser_activity_description_html": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-05-22 10:13:10.021000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points for writing a review.",
      "created_date": "2021-03-15 12:59:39.824000",
      "activity_name": "Write a Review",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c19c",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 200,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "anniversary_bonus",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-05-22 10:07:02.905000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points on your anniversary.",
      "created_date": "2021-03-15 12:59:39.836000",
      "activity_name": "Anniversary Bonus",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c19e",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "f00ca_custom_activity",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-05-17 11:21:50.190000",
      "metadata": {},
      "enduser_activity_short_description": "",
      "created_date": "2021-05-05 05:29:46.129000",
      "activity_name": "",
      "is_points_expiry_reset_activity": false,
      "id": "60922d4abed0d56677192dcf",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "referral",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-05-12 11:10:12.088000",
      "metadata": {},
      "enduser_activity_short_description": "Award points on referral purchase.",
      "created_date": "2021-03-22 08:46:18.898000",
      "activity_name": "Refer a Friend",
      "is_points_expiry_reset_activity": false,
      "id": "6058595abb711d6fa73fcd36",
      "activity_benefit_type": "points_and_coupon_code"
    },
    {
      "points_config": {
        "points": 500,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "684fc_custom_activity",
      "enduser_activity_description_html": "<div data-paperform-id=\"swldehbf\"></div><script>(function() {var script = document.createElement('script'); script.src = \"https://paperform.co/__embed.min.js\"; document.body.appendChild(script); })()</script>",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-04-10 11:47:27.127000",
      "metadata": {},
      "enduser_activity_short_description": "Enter the code on your LD pack and earn points",
      "created_date": "2021-05-05 11:41:57.738000",
      "activity_name": "684fc_custom_activity",
      "is_points_expiry_reset_activity": true,
      "id": "609284851c9396204c8b984b",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "a7ee1_custom_activity",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-03-08 11:01:06.969000",
      "metadata": {},
      "enduser_activity_short_description": "Reward your users for any activity you want.",
      "created_date": "2023-01-23 13:52:30.665000",
      "activity_name": "Custom Activity",
      "is_points_expiry_reset_activity": true,
      "id": "63ce911ef380d8000b8d7753",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 130,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "birthday_bonus",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2023-02-24 07:27:55.290000",
      "metadata": {},
      "enduser_activity_short_description": "Award points on birthday.",
      "created_date": "2021-03-15 12:59:39.830000",
      "activity_name": "Birthday Bonus",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c19d",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "upload_photo",
      "enduser_activity_description_html": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-10-06 10:26:28.835000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points for uploading a photo.",
      "created_date": "2022-07-28 06:53:03.616000",
      "activity_name": "Upload a Photo",
      "is_points_expiry_reset_activity": false,
      "id": "62e2324f23d74243d1c5af29",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points_computation_type": "multiplier_based",
        "attribute_to_multiply": "receipt_order_value",
        "multiplier": 1
      },
      "activity_id": "submit_a_receipt",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": true,
      "last_modified_date": "2022-10-06 09:54:55.183000",
      "metadata": {},
      "enduser_activity_short_description": "Reward users for submitting receipts of their purchases.",
      "created_date": "2021-03-22 08:56:14.632000",
      "activity_name": "Submit A Receipt",
      "is_points_expiry_reset_activity": false,
      "id": "60585baef5a67a16e1871b56",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "follow_on_instagram",
      "enduser_activity_description_html": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-07-14 08:17:25.289000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points when you follow us on Instagram.",
      "created_date": "2021-03-15 12:59:39.886000",
      "activity_name": "Follow on Instagram",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c1a4",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 50,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "share_on_pinterest",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-07-14 08:17:19.592000",
      "metadata": {},
      "enduser_activity_short_description": "Earn points when you share us on Pinterest.",
      "created_date": "2021-03-15 12:59:39.873000",
      "activity_name": "Share on Pinterest",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c1a3",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 50,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "share_on_facebook",
      "enduser_activity_description_html": "",
      "activity_card_background_image_url": "https://d1qbqkkh49kht1.cloudfront.net/ece73c1fcf03cf1a006b2dac79097600.png",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-07-14 08:17:00.673000",
      "metadata": {},
      "enduser_activity_short_description": "Reward points to users when they share you on Facebook.",
      "created_date": "2021-03-15 12:59:39.848000",
      "activity_name": "Share on Facebook",
      "is_points_expiry_reset_activity": false,
      "id": "604f5a3b8152252216f5c1a0",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points": 100,
        "points_computation_type": "fixed_points"
      },
      "activity_id": "f46f4_custom_activity",
      "enduser_activity_description_html": "<iframe id=\"quiz-form\" width=\"100%\" height=\"300px\"  style=\"margin-top:-50px;border:none !important;\"></iframe>",
      "activity_card_background_image_url": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-06-14 11:09:16.199000",
      "metadata": {},
      "enduser_activity_short_description": "Reward your users for any activity you want.",
      "created_date": "2022-03-03 05:30:58.331000",
      "activity_name": "Quiz form",
      "is_points_expiry_reset_activity": false,
      "id": "622052924e6d9f1dfd89ed88",
      "activity_benefit_type": "points"
    },
    {
      "points_config": {
        "points_computation_type": "multiplier_based",
        "multiplier": 1
      },
      "activity_id": "code_submission",
      "enduser_activity_description_html": "",
      "is_qualified_for_tier_upgrade": false,
      "last_modified_date": "2022-05-19 10:32:40.318000",
      "metadata": {},
      "enduser_activity_short_description": "Get rewarded for your purchases by submitting the code you received with your purchase.",
      "created_date": "2022-05-18 10:05:41.642000",
      "activity_name": "Enter a Code",
      "is_points_expiry_reset_activity": false,
      "id": "6284c4f5dfa6b7425568ba6d",
      "activity_benefit_type": "points"
    }
  ],
  "next_cursor": 100,
  "more": false
}