Post a check reporting data request for a specific time range

Creates a check reporting data request for a specific time range. Currently, day is the only valid value.

Use the onlyInactiveRestaurants query parameter set to true to get data for inactive restaurants only.

Specify the startBusinessDate and endBusinessDate for the data in the message body.

Identify restaurants to include or exclude with the restaurantIds and excludedRestaurantIds properties. If left blank, all restaurants are included by default.

Securityoauth2
Request
path Parameters
timeRange
required
string

The specific time range that you are requesting the data for. Currently, day is the only valid value.

Value: "day"
query Parameters
onlyInactiveRestaurants
boolean

Specifies whether the data is for inactive restaurants only. Active restaurant data is returned by default.

Valid values:

  • true - The data retrieved is for inactive restaurants only.

  • false - The data retrieved is for active restaurants only.

Request Body schema: application/json

A JSON object containing the starting and ending dates for the check reporting data request and included or excluded restaurants.

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.

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.

Responses
200

The reportRequestGuid used to retrieve the data.

400

The request contains invalid information.

500

An unexpected internal error occurred. The requestId attached to this error can be referenced by the Toast support team.

post/check/{timeRange}
Request samples
application/json
{
  • "startBusinessDate": 0,
  • "endBusinessDate": 0,
  • "restaurantIds": [
    ],
  • "excludedRestaurantIds": [
    ]
}
Response samples
application/json
"string"