- 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
Description
Retrieves the summary of information and data about a business for a given number of months.
General
| End Point | https://www.mogl.com/api/v2/venues/{business}/summary |
| HTTP Method | GET |
| Requires SSL | true |
| Requires Acting User | false |
| Scope(s) | None |
Path Parameters
Path parameters are ALWAYS required.
| business | The business id of the business. |
Request Parameters
Parameters are NOT REQUIRED unless noted otherwise.
| offset | The offset to pull months from (e.g. 0 is current which is default). |
| numResults | The number of months to pull. |
Response Fields
| results | A list of business summary objects. See results details, See businessSummary details |