Skip to main content
GET
/
api
/
v4.0
/
integrations
/
customers
/
{customerId}
/
activities
Get Customer Activities
curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/activities \
  --header 'apikey: <api-key>' \
  --header 'secretkey: <api-key>'
{
  "activities": [
    {
      "activityId": 123,
      "activityType": "<string>",
      "activityDay": "<string>",
      "activityDate": "<string>",
      "activityTime": "<string>",
      "customerId": "<string>",
      "email": "<string>",
      "phoneNumber": "<string>",
      "displayName": "<string>",
      "transactionId": "<string>",
      "isManualActivity": true,
      "points": 123,
      "score": 123,
      "reason": "<string>",
      "calculatedRedemption": 123,
      "actualRedemption": 123,
      "familyRedemptionAmount": 123,
      "familyRedemptionPoints": 123,
      "paymentRewardAmount": 123,
      "outstandingPoints": 123,
      "rewardThreshold": 123,
      "currency": "<string>",
      "redemptionRewardFactor": 123,
      "campaignName": "<string>",
      "campaignStartDate": "<string>",
      "campaignEndDate": "<string>",
      "campaignEnabled": true,
      "tierName": "<string>",
      "rewardPoints": 123,
      "rewardFactor": 123,
      "isGuest": true,
      "couponUsed": true,
      "couponType": "<string>",
      "couponCode": "<string>",
      "couponGroup": "<string>",
      "couponProduct": "<string>",
      "couponProductId": 123,
      "productVariantName": "<string>"
    }
  ],
  "count": 123,
  "hasMore": true
}
This API retrieves a log of customer activities within Gameball, identified by customerId. The logs detail various actions, such as tier changes, campaign rewards, referrals, redemptions, and more. Specific activity types can be filtered, including events like TierUpgraded, CampaignRewarded, ReferralBonusReward, and PaymentReward, providing comprehensive visibility into each customer’s engagement history.
Security: Requires apikey and secretkey headers.

Authorizations

​
apikey
string
header
required
​
secretkey
string
header
required

Path Parameters

​
customerId
string
required

Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email, or anything that uniquely identifies the customer.

Query Parameters

​
startAfter
integer<int64>
default:0

Specifies the page will start after which activity id. Defaults to 0.

​
limit
integer
default:50

Specifies the number of activities to return per page. Defaults to 50, with a maximum limit of 200 transactions per page.

Required range: x <= 200
​
activityType
enum<string>

Filters activities by a specific type, such as: TierUpgraded (Indicates that the customer has been upgraded to a new tier), TierDowngraded (Indicates that the customer has been downgraded to a lower tier), TierMigration (Represents the migration of the customer's tier), CampaignRewarded (Signifies that the customer received a reward from a campaign), SuccessfulAction (Denotes successful progress by the customer in a campaign), Referral (Indicates that the customer referred a friend), Referred (The referee received a reward for being referred by the customer), ReferralBonusReward (Represents a bonus reward given for a referral), PaymentReward (Signifies that the customer received a cashback reward), Refund (Points were refunded back to the customer), Redemption (Points were redeemed by the customer), Cancel (A cashback transaction was canceled), Expiry (Indicates that points have expired), Migration (Represents a migration activity that occurred), Lifetime (Refers to activities related to lifetime coupons), Automation (Activity performed by an automation campaign).

Available options:
TierUpgraded,
TierDowngraded,
TierMigration,
CampaignRewarded,
SuccessfulAction,
Referral,
Referred,
ReferralBonusReward,
PaymentReward,
Refund,
Redemption,
Cancel,
Expiry,
Migration,
Lifetime,
Automation

Response

200 - application/json

Customer activities retrieved successfully

​
activities
object[]

An array of activity records for the customer

​
count
number

The total number of activities on the current page

​
hasMore
boolean

Whether there are additional logs to be fetched