Labor reporting data overview

Labor reporting data includes detailed information about employees and jobs that are paid hourly. For more information about what is included in the labor reporting data, see Understanding the labor reporting data. For more information about inactive restaurant data, see Viewing inactive restaurant data.

Retrieving the labor reporting data is a two-step process. You must:

  1. Send a POST request to the /era/v1/labor/{timeRange} endpoint to create a request for labor reporting data for the restaurants in a management group. The response is the reportRequestGuid, the unique request identifier. The analytics API supports retrieving labor reporting data for the day, week, and month time ranges. For more information, see Creating a request for labor reporting data.

  2. Send a GET request to the /era/v1/labor/{reportRequestGuid} endpoint to retrieve the labor reporting data. For more information, see Retrieving the aggregated sales reporting data.

Note

The reportRequestGuid expires seven days after you create it. Using an expired or invalid reportRequestGuid results in a 404 error. The message of the response body contains additional information about the cause of the error.