- API Documentation
- Overview
- Authentication
- Events
- Integration
- API Endpoints
- BillingAccounts
- Cards
- list
- Actions
- add
- delete
- deleteByNumber
- setPrimary
- Devices
- Fundraisers
- Invoices
- lookup
- Aspects
- adjustments
- invoiceTransactions
- transactions
- Actions
- collect
- Metros
- list
- Aspects
- summary
- topBusinesses
- topUsers
- Offers
- Payments
- Reports
- Subscriptions
- Users
- add
- alerts
- donateList
- donateLookup
- forgotPassword
- listOAuth
- lookup
- notificationSettings
- payments
- rewardList
- search
- signupWithCard
- Utilities
- categories
- extendedCategories
- features
- info
- locationSuggestions
- searchSuggestions
- searchSuggestionsMap
- Actions
- Venues
- Response Objects
- address
- alert
- application
- billingAccount
- businessStatsReport
- businessSummary
- card
- cashReward
- category
- chain
- collectionItem
- compactUser
- compactVenue
- device
- donation
- event
- fundraiser
- fundraiserSummary
- fundraiserUserTotal
- invoice
- invoiceAdjustment
- invoiceTransaction
- media
- merchantInfo
- metro
- offer
- offerDetails
- offerLink
- payable
- redemption
- results
- searchResults
- statsSummary
- subscription
- transaction
- transactionReport
- upgradeAction
- user
- userSegment
- userSummary
- userVenueTotal
- variableReward
- venue
Returns a summary of aggregate information over transactions.
Properties
groupedByValue |
The value of the grouped by property.
This field is optional and will not be returned when there is no value or not applicable. |
cashback | Cashback awarded to customers. |
cashbackBilled | Cashback billed to merchants. |
mostRecentTxDate |
Most recent transaction date.
This field may be null when there is no value or not applicable. |
numCustomers | The total number of unique customers. |
numFirstCustomers | The number of first time customers. |
numTransactions | The number of transactions. |
referralFee | The total referral fee billed. |
revenue | The amount of revenue earned. |
businessId | The business id of the business in question (if applicable). |
period | The period (if applicable). |