Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get customer activity history

get/partnerProgram/customerActivityHistories

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP' required

Source in which the customer identifier is available.

identifierName'mobile' | 'email' | 'externalId' | 'wechat' required

Name of the customer identifier used to identify the customer.

identifierValuestring required

Value of the specified identifierName.

activityType'linkingupdates' | 'benefitsAvailed' required

The type of activity.

startDatestring date

when activityType is BENEFITS_AVAILED , startDate param is used to fetch CustomerBenefitTrackingLog during that duration

endDatestring date

when activityType is BENEFITS_AVAILED , endDate param is used to fetch CustomerBenefitTrackingLog during that duration

partnerProgramIdinteger

If partnerProgramId is passed, then only that partner program details will be fetched, else 10 partner programs which the customer was recently part of will be shown. (Order will Recently became part of -> Oldest part of.)

partnerProgramType'EXTERNAL' | 'SUPPLEMENTARY'

The type of partner program type. Subscription (External) or Coalition (Supplementary).

limitinteger

Default limit will be 10. value could be between 1-10.

offsetinteger

Default offset will be 0.

Response

200

OR

Example response

{
  "pagination": {
    "limit": 10,
    "total": 3
  },
  "data": [
    {
      "partnerProgramDetails": {
        "programName": "VidhiOrgDefaultProgram",
        "partnerProgramId": 111,
        "partnerProgramName": "external pp",
        "partnerProgramDescription": "external pp",
        "partnerTierNumber": 2,
        "partnerTierName": "tier2",
        "partnerTierExpiryDate": "2024-09-08T18:29:59Z",
        "partnerMembershipId": "000103",
        "partnerProgramType": "EXTERNAL",
        "partnerProgramMembershipStartDate": "2023-09-08T18:25:10Z",
        "partnerProgramMembershipEndDate": "2024-09-08T18:29:59Z",
        "benefitsSummary": [
          {
            "name": "benefit21",
            "type": "promotionalPoints",
            "mappedPromotionDetails": {
              "promotionId": 16692,
              "promotionName": "promo1",
              "promotionReferenceNumber": "dfe3ac53-ee91-48d8-89d5-e5938f4843d8"
            }
          }
        ],
        "linked": true,
        "tierBased": true
      },
      "notes": "showing customer activities from Wed Sep 14 15:51:21 GMT 2022 till Thu Sep 14 15:51:21 GMT 2023"
    }
  ]
}