GetCleans - Details – Hotel Effectiveness

The Context

This dataset returns employee and clean-type level data for housekeeping as entered via Night Audit Entry. These fields are returned via the Housekeeping Cleans DataMiner and are accessible through API access.

Parameters

There are four required parameters for this method:

Location ID - Six digit unique Hotel Effectiveness hotel id, i.e. 104609
Start Date - Start date of your requested data range in YYYY-MM-DD format
End Date - End date of your requested data range in YYYY-MM-DD format
Summary Type - Numerical code for the type of data in your request, i.e. 1 or 6. You can request multiple types in the same call by separating them by a comma with no spaces, i.e. 1,2 Cleans by Day and Cleans by Day by Employee

Authentication

You must send your Username and Password as basic headers in your request.

Sample Call

Below is a sample for pulling actuals and labor standards for one hotel for a given date range

https://data.hoteleffectiveness.com/LaborManagement.svc/GetCleans?locationid=104609&startdate=2026-04-01&enddate=2026-04-01

The Data

Field Name	Definition
Status	API Result Status; it will return as SUCCESS or ERROR.
Status_Description	API Result Description. Leaves blank for Success, or provides details if an error occurs.
paramlocationid	Location ID that was sent in the original request (same for every record returned).
paramstartdate	Start Date that was sent in the original request (same for every record returned).
paramenddate	End Date that was sent in the original request (same for every record returned).
paramoptional	Summary Type that was sent in the original request (same for every record returned).
locationid	Unique location ID of a hotel stored in Hotel Effectiveness.
hotelname	Hotel Name stored in Hotel Effectiveness.
date	Date associated with the cleans (the day the work was completed).
eeid1	Unique employee ID generated by Hotel Effectiveness.
eeid2	Hotel employee ID (likely their payroll ID or the employee code).
eename1	Last and First name of the employee (Plan records may not be specific to an employee).
varid	Unique ID in Hotel Effectiveness for the clean type.
otheevar_name	Name of the clean type.
cleans	Total number of cleans as reported in Night Audit Entry.

Limits

Summary Type Constraints: Depending on the specific Summary Type requested in your API call, the following fields may return blank: eeid1, eeid2, eename1, varid, and otheevar_name.