MetricsReportingData

The aggregated sales reporting data.

avgOrderValue
number <double>

The average amount for an order.

businessDate
string <integer>

The date for the aggregated reporting data. The business day uses the YYYYMMDD format. For example, 20220824.

businessHour
string <integer>

The hour the data represents. This property only appears when the aggregateBy query parameter is set to HOUR in the POST request for creating the reporting metrics request. The hour number corresponds to the 24 hours of the day, starting at 0 and ending at 23.

closedOrderCount
number <integer>

The total number of closed orders.

diningOption
string

The dining option for the data. This property only appears when the request for reporting data includes the groupBy property with value DINING_OPTION.

discountAmount
number <double>

The total amount of discounts for orders.

discountOrderCount
number <integer>

The total number of orders that have at least one discount.

grossSalesAmount
number <double>

The total sales, including discounts and refunds.

guestCount
number <integer>

The total number of guests recorded across all orders.

hourlyJobSalesPerLaborHour
string <double>

The average net sales for each hour worked by employees with hourly jobs.

hourlyJobTotalHours
string <double>

The total hours worked by employees with hourly jobs. This does not include breaks.

hourlyJobTotalPay
string <double>

The total wages earned by employees with hourly jobs, including overtime pay. This does not include tips.

netSalesAmount
number <double>

The total sales, excluding tax, gratuity, tips, discounts, refunds, and deferred amounts.

openOrderCount
number <integer>

The total number of open orders.

ordersCount
number <integer>

The total number of orders that were not voided.

orderSource
any

The method used to place an order, also known as the order source. This property only appears when the request for reporting data includes the groupBy property with value ORDER_SOURCE.

Valid values:

  • API
  • BRANDED_ONLINE_ORDERING
  • CALLER_ID
  • CATERING
  • CATERING_ONLINE_ORDERING
  • GOOGLE
  • GRUBHUB (deprecated)
  • IN_STORE
  • INVOICE
  • KIOSK
  • ONLINE
  • ORDER_AND_PAY_AT_TABLE
  • TOAST_LOCAL
  • TOAST_PICKUP_APP
  • TOAST_TABLES
refundAmount
number <double>

The total amount of refunded sales.

restaurantGuid
string <UUID>

The identifier assigned by the Toast platform used to identify a restaurant location.

restaurantName
string <string>

The restaurant's name. This property is only included when the fetchRestaurantNames parameter is set to true in the GET request.

revenueCenter
string

The revenue center for the data. This property only appears when the request for reporting data includes the groupBy property with value REVENUE_CENTER.

voidOrdersAmount
number <double>

The total amount of voided items.

voidOrdersCount
number <integer>

The total number of orders with at least one voided item.

{
  • "restaurantGuid": "string",
  • "businessDate": "string",
  • "guestCount": 0,
  • "voidOrdersCount": 0,
  • "discountOrderCount": 0,
  • "ordersCount": 0,
  • "openOrderCount": 0,
  • "closedOrderCount": 0,
  • "netSalesAmount": 0,
  • "grossSalesAmount": 0,
  • "discountAmount": 0,
  • "voidOrdersAmount": 0,
  • "refundAmount": 0,
  • "avgOrderValue": 0,
  • "revenueCenter": "string",
  • "diningOption": "string",
  • "orderSource": null,
  • "businessHour": "string",
  • "hourlyJobTotalHours": "string",
  • "hourlyJobTotalPay": "string",
  • "hourlyJobSalesPerLaborHour": "string",
  • "restaurantName": "string"
}