Get Account Analytics

Get account analytics

GET/v1/accounts/{accountId}/analytics

Use it in a workflow

Add a step and choose the Talon.One connector.
Pick the Get Account Analytics action (under management).
Fill in the fields below, then reference the result from later steps as {{getAccountAnalytics.response.data}}.

Request

Path parameters

accountIdinteger (int64)required

The identifier of the account. Retrieve it via the [List users in account](https://docs.talon.one/management-api#tag/Accounts-and-users/operation/getUsers) endpoint in the `accountId` property.

Response

Returns 200 with an object. Read it in later steps with {{getAccountAnalytics.response.data.<field>}}.

applicationsinteger (int64)

Total number of applications in the account.

liveApplicationsinteger (int64)

Total number of live applications in the account.

sandboxApplicationsinteger (int64)

Total number of sandbox applications in the account.

campaignsinteger (int64)

Total number of campaigns in the account.

activeCampaignsinteger (int64)

Total number of active campaigns in the account.

liveActiveCampaignsinteger (int64)

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

couponsinteger (int64)

Total number of coupons in the account.

activeCouponsinteger (int64)

Total number of active coupons in the account.

expiredCouponsinteger (int64)

Total number of expired coupons in the account.

referralCodesinteger (int64)

Total number of referral codes in the account.

activeReferralCodesinteger (int64)

Total number of active referral codes in the account.

expiredReferralCodesinteger (int64)

Total number of expired referral codes in the account.

activeRulesinteger (int64)

Total number of active rules in the account.

usersinteger (int64)

Total number of users in the account.

rolesinteger (int64)

Total number of roles in the account.

customAttributesinteger (int64)

Total number of custom attributes in the account.

webhooksinteger (int64)

Total number of webhooks in the account.

loyaltyProgramsinteger (int64)

Total number of all loyalty programs in the account.

liveLoyaltyProgramsinteger (int64)

Total number of live loyalty programs in the account.

lastUpdatedAtstring (date-time)

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

json

{
  "applications": 11,
  "liveApplications": 6,
  "sandboxApplications": 2,
  "campaigns": 35,
  "activeCampaigns": 15,
  "liveActiveCampaigns": 10,
  "coupons": 850,
  "activeCoupons": 650,
  "expiredCoupons": 200,
  "referralCodes": 500,
  "activeReferralCodes": 100,
  "expiredReferralCodes": 400
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.

Was this page helpful?