Reporting
 |
The Reporting module provides instance access to a variety of reports presenting the most current data across products.
The Reporting API provides access to raw report data generated by our backend systems. This data allows users to generate custom reports, import data into legacy systems, and ensure that data are consistent between our suite of products and integrator systems.
These topics provide a step-by-step guide for working with Reporting API and define the following operations:
Orders - The Orders resource returns an array of order objects based on the query parameters.GET/reporting/orders
Order Items - The Order Items resource returns a list of items associated with a specified Order identifier.GET/reporting/order-items
Order Items Batch - The Order Items Batch resource returns an array of objects, which contains information on order items by business date.GET/reporting/order-items/batch
Order Payments - The Order Payments resource returns a list of payments associated with a specified Order number, or business date.GET/reporting/order-payments
Active Sites - The Active Sites resource returns an array of sales information for active sites.GET/reporting/active-sites
Item Summary - The Item Summary resource returns an array of objects, per active Product, displaying summarized Sales totals.GET/reporting/item-summary
Drawer Summary - The Drawer Summary resource returns an array of objects, per Drawer Session, displaying summarized totals.GET/reporting/cash-drawer-summary
Drawer Transactions - The Drawer Transactions resource returns an array of objects, per Drawer Transaction, displaying detailed records.GET/reporting/drawer-transactions
Calculations - The Calculations resource returns an array of summarized metrics for sites and dates that you specify.GET/reporting/calculations
Named Calculations - The Named Calculations resource returns an array of metrics from Named Calculations formulas.GET/reporting/named-calculations
Sales by Time - The Sales by Time resource returns time Incremented Net/Gross Sales and Guest counts.GET/reporting/sales-by-time
Discounts - The Discounts resource returns summarized totals for discounts applied on a given Business Date.GET/reporting/discounts
Discounts by Type - The Discounts by Type resource returns an array of discount objects that summarize associated discount totals by type.GET/reporting/discounts/by-type
Statistic by Day Part - The Statistics by Day Part resource returns an array of objects, which contain totals aggregated by Day Parts.GET/reporting/statistic-by-daypart
Statistic by Destination - The Statistics by Destination resource returns an array of objects, which contain totals aggregated by Destinations.GET/reporting/statistic-by-destination
Statistic by Order Source - The Statistics by Order Source resource returns an array of objects, which contain totals aggregated by Order Source.GET/reporting/statistic-by-order-source
Deposits - The Deposits resource returns an array of deposit information for the requested business days.GET/reporting/deposits
Release notes communicate new enhancements and updates in the latest releases of Reporting for ETL, Power BI, and Web App.
To view release notes, select either the production or UAT environment.