Customer Activities

Get Customer Activities

curl --request GET \
  --url https://api.gameball.co/api/v4.0/integrations/customers/{customerId}/activities \
  --header 'apikey: <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
}

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>'

{
  "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

Path Parameters

customerId

string

required

Unique identifier for the customer

Query Parameters

startAfter

integer<int64>

default:0

Specifies the page will start after which activity id

limit

integer

default:50

Number of activities to return per page

Required range: x <= 200

activityType

enum<string>

Filter activities by specific type

Available options:

TierUpgraded,

TierDowngraded,

TierMigration,

CampaignRewarded,

SuccessfulAction,

Referral,

Referred,

ReferralBonusReward,

PaymentReward,

Refund,

Redemption,

Cancel,

Expiry,

Migration,

Lifetime,

Automation

Response

200 - application/json

Customer activities found

activities

object[]

An array of activity records for the customer

Show child attributes

activities.activityId

number

Unique identifier for the activity

activities.activityType

string

The type of activity that occurred

activities.activityDay

string

The day of the week when the activity took place

activities.activityDate

string

The date of the activity

activities.activityTime

string

The time when the activity occurred

activities.customerId

string

The unique identifier of the customer

activities.email

string | null

The email address of the customer

activities.phoneNumber

string | null

The customer's phone number

activities.displayName

string | null

The customer's display name

activities.transactionId

string | null

A unique identifier for a transaction in your system

activities.isManualActivity

boolean | null

Whether the activity was manually triggered

activities.points

number | null

The number of points involved in the activity

activities.score

number | null

The score involved in the activity

activities.reason

string | null

Reason entered for manual activities, if provided.

activities.calculatedRedemption

number | null

Estimated monetary value based on redemption factor and involved points.

activities.actualRedemption

number | null

Actual monetary value of redemption, if applicable.

activities.familyRedemptionAmount

number | null

Redemption monetary value related to family wallet, if applicable.

activities.familyRedemptionPoints

number | null

Redemption points related to family wallet, if applicable.

activities.paymentRewardAmount

number | null

Cashback amount rewarded in currency.

activities.outstandingPoints

number | null

Points currently available from the related transaction.

activities.rewardThreshold

number | null

Minimum spend to receive configured reward points.

activities.currency

string | null

Currency used in the transaction.

activities.redemptionRewardFactor

number | null

Conversion rate between points and monetary value during redemption.

activities.campaignName

string | null

Name of the associated rewards campaign, if any.

activities.campaignStartDate

string | null

Start date of the associated campaign.

activities.campaignEndDate

string | null

End date of the associated campaign.

activities.campaignEnabled

boolean | null

Whether the associated campaign was enabled during the activity.

activities.tierName

string | null

Tier name associated with tier-related activities.

activities.rewardPoints

number | null

Number of points rewarded from the activity.

activities.rewardFactor

number | null

Reward factor used to calculate reward points.

activities.isGuest

boolean | null

Whether the actor is a guest (not signed up).

activities.couponUsed

boolean | null

Whether the coupon associated with this activity was used.

activities.couponType

string | null

Type of coupon associated with the activity.

activities.couponCode

string | null

Coupon code associated with this activity.

activities.couponGroup

string | null

Group or campaign to which the coupon is linked.

activities.couponProduct

string | null

Name of the product associated with the coupon, if any.

activities.couponProductId

number | null

ID of the product associated with the coupon.

activities.productVariantName

string | null

Name of the product variant involved in the event.

count

number

The total number of activities on the current page

hasMore

boolean

Whether there are additional logs to be fetched

Customer Referrals Count

Customer Activities Count

⌘I

API documentation

Webhooks

Authorizations

Path Parameters

Query Parameters

Response