Analytics API (1.0.0)

The analytics API provides an enterprise reporting and analytics service, and includes operations that retrieve information for all restaurants, or a subset of restaurants, in a management group, create requests for reporting data, and retrieve the reporting data.

The types of reporting data include:

  • Aggregated sales reporting data covering sales and labor information.
  • Check reporting data providing information for each check.
  • Labor reporting data providing information for employees and jobs that are paid hourly.
  • Menu reporting data providing information for menu entities as they relate to sales.
  • Payout reporting data providing information for payouts organized either by settled date, payments, or sales date.
  • Guest reporting data providing information for guest's payment cards organized by payments.

Aggregated sales

The analytics API endpoints for aggregated sales reporting data covering sales and labor information.