MenuReportingDataRequest

Information about what the menu 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 only use the `groupBy` property when requesting data for a `day` or `week` time range. Valid values: `MENU` - The reporting data is grouped by menu. `MENU_GROUP` - The reporting data is grouped by menu group. `MENU_ITEM` - The reporting data is grouped by menu item. `MODIFIER` - The reporting data is grouped by modifier. Items Enum: "MENU" "MENU_GROUP" "MENU_ITEM" "MODIFIER"
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": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"excludedRestaurantIds": ["string"
],
"groupBy": ["MENU"
]
}