Description
Allows retrieval of summaries of transactional data.
General
| End Point | https://www.mogl.com/api/v2/reportstats/txReport |
| HTTP Method | GET |
| Requires SSL | true |
| Requires Acting User | false |
| Scope(s) | None |
Path Parameters
Path parameters are ALWAYS required.
None
Request Parameters
Parameters are NOT REQUIRED unless noted otherwise.
| startDate | Include stats data starting from this date [YYYY/MM/DD]. |
| endDate | Include stats data ending from this date [YYYY/MM/DD]. |
| byProcessDate | Whether the start and end date are the transaction dates OR the dates that the transactions are processed. Typically, for example, with invoices you would use the process date but for dashbaords would use the transaction date. |
| business | required The business to pull the stats report for. |
| groupingOption | The grouping option to group the report by [DAY_OF_MONTH, MONTH_OF_YEAR, GENDER, ZIPCODE, PUBLISHER_DATE]. |
| sortingOption | The sorting option to sort the report by [GROUPED_BY_VALUE, CASHBACK, REVENUE, RECENT, MONTH_YEAR]. |
| offset | The offset into the results |
| numResults | The number of results to retrieve (default 100) |
Response Fields
| results | A list of transaction reports See results details, See transactionReport details |