MetricsReportingDataRequest

Information about what the aggregated sales reporting data covers and how it is presented. This includes the starting and ending dates of the time range, the included or excluded restaurants, and aggregation options.

endBusinessDate
required
number <integer>

The ending date of the time range for the reporting data.

Specify the business day in the format YYYYMMDD. For example, 20220824.

excludedRestaurantIds
required
Array of strings <UUID>

The restaurantGuid values of specific restaurants in the management group to exclude from the reporting data. If used, the data for listed restaurants in the management group that are identified by restaurantGuid is excluded. If left blank, all restaurants are included by default.

groupBy
Array of strings

The way the reporting data results are aggregated. You can use up to two values at a time.

Valid values:

  • DINING_OPTION - The reporting data is grouped by dining option.
  • ORDER_SOURCE - The reporting data is grouped by order source.
  • REVENUE_CENTER - The reporting data is grouped by revenue center.
Items Enum: "REVENUE_CENTER" "DINING_OPTION" "ORDER_SOURCE"
restaurantIds
required
Array of strings <uuid>

The restaurantGuid values of specific restaurants in the management group to include in the reporting data. If used, only the data for listed restaurants in the management group that are identified by restaurantGuid is included. If left blank, all restaurants are included by default.

startBusinessDate
required
number <integer>

The starting date of the time range for the reporting data.

Specify the business day in the format YYYYMMDD. For example, 20220824.

{
  • "startBusinessDate": 0,
  • "endBusinessDate": 0,
  • "restaurantIds": [
    ],
  • "excludedRestaurantIds": [
    ],
  • "groupBy": [
    ]
}