> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/dashboard.md).

# Dashboard

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). Platforms: web. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/housekeeping/dashboard.md).
{% endhint %}

Each staff member's progress for the day: completion, total time, and tasks by status and by clean type; the tab only reads today's data and changes nothing.

![Dashboard](https://3653879137-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsVVGa79QbcEkJ7n8srxe%2Fuploads%2Fgit-blob-bcc970a7a0c8884f622e4bd947798f37131743aa%2Fdashboard.png?alt=media)

* **Where:** web `/housekeeping`, "Dashboard" tab. It is the tab a site opens on when no tab was saved for it; the page and its tabs are described on [Staff schedule](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/schedule.md).
* **Who:** site admins (role "Admin") on a site with housekeeping on, while no multi-site is selected; other users are sent to `/fix`.
* **Feature:** [Housekeeping reports](https://docs.snapfix.com/product/features/housekeeping/housekeeping-reports.md)

The table shows the same staff and tasks as the [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md). The housekeeping reports for site admins in the Ops Dashboard are a separate screen ([Ops Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/ops-dashboard.md)).

## Layout

The board's header, search box and tabs sit above the table, and the unassigned task list of the [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#layout) below it. Of the header buttons only "+", the expand icon and the print icon work on this tab; see [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#header-and-bulk-actions-web).

1. **Header row,** kept in view while the table scrolls. "Dashboard" over the first column, which also stays in view when the table scrolls sideways. Then "Completion" and "Total Time", then "To do", "In Progress" and "Done", each with a dot of its colour (red, amber, green), then one column per clean type of the site, with its icon and name. With many clean types the table scrolls sideways.
2. **Role groups,** in this order: "Both (Inspector & Housekeeper)", "Self Checker", "Inspector", "Housekeeper", "House Person" and "HK Maintenance". A person is in the group of their first working range today. A group with nobody in it is not shown.
3. **One row per person on today's schedule,** in the order the server lists them (earliest working time first), including people with no tasks. The name cell shows the avatar, the name and, when some of the person's tasks fall outside their working hours, a red count of those tasks. The other cells:
   * **Completion:** the share of the person's tasks that are done, as a whole percentage, with a bar and "{done} of {total}", such as "0 of 1". A person with no tasks shows "0%" and "0 of 0".
   * **Total Time:** the person's `totalTime` from [assigned-tasks/list](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#staff-schedule-object), as HH:MM:SS, or "00:00:00" when there is none.
   * **To do, In Progress, Done:** the person's red, amber and green tasks.
   * **Clean types:** how many of the person's tasks have each clean type; a touch-up sub type counts under its clean type.

Each task counts once, even if it appears twice in the day's data. Rows are not clickable. To open a task, use the [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md#task-actions).

## Inputs

None. The search box above the tabs is shown, and the text can be typed, but the rows do not change. Switching tabs clears it. The board's filters do not apply here: the table counts all of the day's tasks.

## Actions

| Action            | Who   | What happens                                                                                                                                                                                                                                                           | API                                                                                                                                                                                                                                                                                                 |
| ----------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the tab      | Admin | Loads today's assigned tasks with a spinner, and reloads the task list below. The people come from the staff list the page loaded ([Staff schedule](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/schedule.md#actions)).                             | [`POST /v1/app/housekeeping/assigned-tasks/list`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingassigned-taskslist), [`POST /v1/app/housekeeping/tasks`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingtasks) |
| Automatic refresh | None  | Every 60 seconds while this tab is open and the browser tab is visible, and when the browser tab becomes visible again more than a minute after the last refresh. Reloads the day's assigned tasks and the task list without a loader; the staff list is not reloaded. | [`POST /v1/app/housekeeping/assigned-tasks/list`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingassigned-taskslist), [`POST /v1/app/housekeeping/tasks`](https://docs.snapfix.com/engineering-reference/api/housekeeping.md#post-v1apphousekeepingtasks) |
| Switch tab        | Admin | Opens "Schedule" or "Timeline". The choice is saved for the site in the browser.                                                                                                                                                                                       | None                                                                                                                                                                                                                                                                                                |

## States

* **Loading:** a spinner replaces the rows when the tab opens. Refreshes do not show it.
* **Empty:** "No data available" when there is no row. A day with nobody on the schedule shows "Start Your Day" ([Staff schedule](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/schedule.md)) instead of the board.
* **Error:** the dashboard has no message of its own; the shared error alert shows, and the rows already shown stay.
* **No permission:** as under **Who**.
* **Offline:** the web has no offline mode.

## Dialogs and sheets

None.

## Platform differences

Web only. The iOS and Android housekeeping screens show no per-person totals; their day view is the [Task timeline](https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/timeline.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/how-the-apps-work/screens/housekeeping/dashboard.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
