TAtalon
Accounts and users

Get account analytics

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Return the analytics of your Talon.One account.

get/v1/accounts/{accountId}/analytics

Request

Path parameters

accountIdinteger required

The identifier of the account. Retrieve it via the List users in account endpoint in the accountId property.

Response

OK

applicationsinteger required

Total number of applications in the account.

liveApplicationsinteger required

Total number of live applications in the account.

sandboxApplicationsinteger required

Total number of sandbox applications in the account.

campaignsinteger required

Total number of campaigns in the account.

activeCampaignsinteger required

Total number of active campaigns in the account.

liveActiveCampaignsinteger required

Total number of active campaigns in live applications in the account.

couponsinteger required

Total number of coupons in the account.

activeCouponsinteger required

Total number of active coupons in the account.

expiredCouponsinteger required

Total number of expired coupons in the account.

referralCodesinteger required

Total number of referral codes in the account.

activeReferralCodesinteger required

Total number of active referral codes in the account.

expiredReferralCodesinteger required

Total number of expired referral codes in the account.

activeRulesinteger required

Total number of active rules in the account.

usersinteger required

Total number of users in the account.

rolesinteger required

Total number of roles in the account.

customAttributesinteger required

Total number of custom attributes in the account.

webhooksinteger required

Total number of webhooks in the account.

loyaltyProgramsinteger required

Total number of all loyalty programs in the account.

liveLoyaltyProgramsinteger required

Total number of live loyalty programs in the account.

lastUpdatedAtstring date-time required

The point in time when the analytics numbers were updated last.

Example response

{
  "applications": 11,
  "liveApplications": 6,
  "sandboxApplications": 2,
  "campaigns": 35,
  "activeCampaigns": 15,
  "liveActiveCampaigns": 10,
  "coupons": 850,
  "activeCoupons": 650,
  "expiredCoupons": 200,
  "referralCodes": 500,
  "activeReferralCodes": 100,
  "expiredReferralCodes": 400,
  "activeRules": 35,
  "roles": 10,
  "customAttributes": 18,
  "webhooks": 2,
  "loyaltyPrograms": 5,
  "liveLoyaltyPrograms": 5,
  "lastUpdatedAt": "2022-12-12T12:12:12Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.