> 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/reports/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/reports/dashboard.md).
{% endhint %}

Charts of task activity for the groups and dates chosen in the filters: a summary by status colour, the status by day, a comparison with the period before, a table of groups, a map of task locations, and tables of users and tags.

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

* **Where:** web `/dashboard-reports/dashboard`, the "Dashboard" tab of "Dashboard & Reports" (side menu "Dashboard & Reports", shown to every user, also while a multi-site is selected). Any other path under `/dashboard-reports/` opens this tab.
* **Who:** any signed-in user. The route has no guard and the page has no role or plan check. The API decides which groups count, and it does not check that the caller belongs to the groups in the request.
* **Feature:** [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md)

The tabs "Task Reports" and "Asset Reports" share this page's header and filters: [Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md) and [Asset reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/asset-reports.md). The tab "Ops Dashboard" is [Ops dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/ops-dashboard.md).

## Layout

1. **Header.** The title "Dashboard & Reports", then the tabs "Dashboard", "Ops Dashboard", "Task Reports" and "Asset Reports". "Ops Dashboard" shows only for role "Admin", and not on sites whose `taskDashboardEnabled` is 0. Below the tabs: the tab's name as the page title and the filter button ("Filter"), whose icon changes when filters other than the defaults are set. The button is off while the groups load. With a multi-site selected, the header also has a site selector.
2. **Filter banner.** One chip for each filter in use, the defaults included. On a new visit the chips read "Active tasks", "3 task status color(s)", "Created date: - " and " group(s)", with "Clear all".
3. **Summary row.** Left, one third: "Task summary", a donut and three numbered rows with each status's name, count and share. Right, two thirds: "Total number of tasks by status color", a stacked line chart with one line per status and a day axis, with the status names above it.
4. **Comparison.** Three charts side by side: "Newly created tasks", "Tasks progressing to yellow" and "Tasks moved to green". Each draws an "Actual" line (the chosen period) and a "Previous" line (the period of the same length before it). The "Previous" line is drawn with no visible stroke, so only "Actual" shows. The names appear only in the hover label; the charts have no legend \[[ASK-122](https://github.com/snapfix/docs/blob/main/ASK.md#ask-122-should-the-comparison-charts-show-the-previous-line)].
5. **Group overview.** A full-width table: "Group name" (with the group's image), "Address/Details", "Business" (the site), three columns headed by a red, an amber and a green dot, "# New tasks", "# Progressed to yellow", "# Moved to Green", "Interactions" and "Last updated". Every column sorts. It shows five rows a page and scrolls sideways when the window is narrow. Rows are not clickable.
6. **Tasks by GPS location.** A map with a pin for each task that has a location, in the colour of the task's status. The map starts on a fixed point in Ireland at zoom 7, and fits the pins when there are any. Google's "Map" and "Satellite" buttons and full-screen control are on it.
7. **Tasks with Activity, by User** (left half) and **Tasks by tags** (right half). "Tasks with Activity, by User" has "User name" (with the user's picture), the three dot columns and "# Moved to Green". "Tasks by tags" has "Tag name" and the same columns. Both sort by any column and show five rows a page.

Each chart card (summary row and comparison) has a toolbar to zoom in, zoom out, zoom to a selection and reset. The charts have no download menu: the chart library writes "Download SVG", "Download PNG" and "Download CSV" into the page, but downloads are turned off, so no control opens them.

The group, user and tag tables each have an expand button while they have rows. Expanded, the table fills the page with 25 rows a page and a choice of 5, 10, 25 or 100, and the other panels hide. The minimise button returns to the page. A filter change also returns to the page.

What the numbers count:

* The task summary, the status chart, the comparison, the map and the user and tag tables count the tasks that match the filters.
* The group overview has a row only for groups with matching tasks. In each row, "# New tasks", "# Progressed to yellow" and "# Moved to Green" count the matching tasks. The three dot columns count all the group's tasks, "Interactions" counts all the group's chat entries, with no date filter, and "Last updated" is the group's own change time ([group summary](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardgroup_summary)).
* The legends name the statuses as the task filters do: "New Tasks", "Tasks In Progress" and "Completed Task", the same fixed texts on every site. The status chart's hover labels say "Red", "Yellow" and "Green", and the comparison and the group table say "yellow".

## Inputs

The filters come from the filter drawer and the banner, shared with the two report tabs. The drawer has the tabs "Snapfilters" and "Advanced" and the buttons "Clear Filters" and "Apply" ("Apply" is off until something changes); its rules are in [Filters](https://docs.snapfix.com/how-the-apps-work/screens/tasks/group-tasks.md#filters). Each filter goes to the API as one of the [report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields).

| Field                                  | Type                                                        | Required | Default                                                                                                                                                       | Rules and messages                                                                                                                                                           |
| -------------------------------------- | ----------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Groups ("… group(s)")                  | Several groups of the site                                  | No       | The user's own groups of the selected site, from [`GET /v1/app/businesses`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses) | Sent as `business_uuids`. An empty selection is applied as all of them again.                                                                                                |
| Status ("Status")                      | Switches "New Tasks", "Tasks In Progress", "Completed Task" | No       | All on ("3 task status color(s)")                                                                                                                             | Sent as `colors`.                                                                                                                                                            |
| Priority ("Priority")                  | Chips "1" and "2"                                           | No       | None                                                                                                                                                          | Sent as `priorityLevel`, which the dashboard applies.                                                                                                                        |
| "Active tasks", "Archived tasks"       | Switches                                                    | No       | Active on, archived off                                                                                                                                       | Sent as `normal_tasks` and `archived`. Removing one of the two chips turns the other on.                                                                                     |
| "Assigned to me"                       | Switch                                                      | No       | Off                                                                                                                                                           | Adds the signed-in user to the assignees.                                                                                                                                    |
| People: "Created by", "Assigned to"    | Several users                                               | No       | None                                                                                                                                                          | Sent as `user_uuids_created_by` and `user_uuids_assigned_to`.                                                                                                                |
| "Tag folders"                          | Tags                                                        | No       | None                                                                                                                                                          | Sent as `tagnames` (the tags' IDs).                                                                                                                                          |
| "Assets"                               | Assets                                                      | No       | None                                                                                                                                                          | Sent as `asset_uuids`.                                                                                                                                                       |
| Dates: "Created date", "Activity date" | Date ranges                                                 | No       | Created from one month ago to today                                                                                                                           | Sent as `created_start_date` and `created_end_date`, or `activity_start_date` and `activity_end_date`. `period` is the number of days between the dates, or 30 with no date. |
| "Only includes tasks with cost"        | Switch ("Advanced")                                         | No       | Off                                                                                                                                                           | Sent as `with_cost`, which the dashboard never applies.                                                                                                                      |

The page also sends the signed-in user as `user_uuid` and the selected site as `parent_uuids`. "Clear all" in the banner returns to the defaults, including all of the user's groups.

## Actions

| Action                                                       | Who                | What happens                                                                                                                                                                                                                                                                                                   | API                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------ | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Open the tab                                                 | Any signed-in user | Loads the site's groups, then the seven panels. Each panel asks for its own data.                                                                                                                                                                                                                              | [`tasks_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardtasks_summary), [`status_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardstatus_summary), [`compare_summary_statuswise`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardcompare_summary_statuswise), [`group_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardgroup_summary), [`location_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardlocation_summary), [`user_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboarduser_summary), [`tag_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardtag_summary) |
| Apply a filter, remove a chip, or "Clear all"                | Any signed-in user | Reloads all seven panels. On the QA site the calls took 1.7 to 3.6 seconds on a load and 2.2 to 5.2 seconds after a filter change (2026-11-13); each summary loads every matching task.                                                                                                                        | The same seven                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Expand or minimise a table                                   | Any signed-in user | Changes the page size and hides or shows the other panels.                                                                                                                                                                                                                                                     | None                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Zoom a chart                                                 | Any signed-in user | Zooms the chart in the browser.                                                                                                                                                                                                                                                                                | None                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| Click a map pin, then the task title                         | Any signed-in user | The title reads "Loading" while the task is read. On success, opens the task at `/group/<group>/task/<task>` ([Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md)). On failure, goes to `/group/task/<task>`, a route that does not exist, so the app falls back to `/fix`. | [`GET /v1/app/tasks/{uuid}`](https://docs.snapfix.com/engineering-reference/api/tasks.md#get-v1apptasksuuid)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Switch to "Ops Dashboard", "Task Reports" or "Asset Reports" | As above           | Opens that tab. Moving to or from "Asset Reports" reloads the group list.                                                                                                                                                                                                                                      | None here                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Switch site                                                  | Any signed-in user | Returns to the "Dashboard" tab and reloads the groups and the panels.                                                                                                                                                                                                                                          | As on open                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |

The page does not call `compare_summary_datewise`, which has no caller.

When the page opens, it asks the survey tool (Survicate) to show the survey for `WebDashboardScreen`, with the site's ID, name and customer type and the user's role \[[ASK-116](https://github.com/snapfix/docs/blob/main/ASK.md#ask-116-may-the-survey-tool-receive-users-contact-details-and-site-names)].

## States

* **Loading:** the task summary, status and comparison panels show a skeleton placeholder. The group, user and tag tables and the map show a spinner while their request runs.
* **Empty:** the tables show "No data available" and the task summary shows 0 and 0% for each status. The status and comparison charts draw zero lines, since the API answers with a day list even when no task matches. When an assignee or asset filter matches no task, the API answers "no jobs found": the comparison draws no lines, and the status chart keeps the lines of the previous filter. The map shows no pins and returns to its start view.
* **Error:** no panel shows a message; the dashboard requests skip the app's error dialog. A failed summary shows zeros, a failed table shows "No data available", and the status chart keeps its previous lines.
* **Location retry:** while Google Maps has not loaded, the map asks for the location data again every 200 ms. If the Maps script never loads (for example, when it is blocked), the requests go on, also after the user leaves the page.
* **No permission:** none on this page.
* **Offline (mobile):** not applicable, web only.

## Dialogs and sheets

* **Filters:** the shared filter drawer, as under [Inputs](#inputs).
* **Map info window:** the task's image (or its large-text title), a priority icon when the task has priority, the status colour, the title as a link and the creation date.

## Platform differences

Web only. The apps have a smaller screen for one group or asset register, built on the device: [Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md). The web adds the status by day, the comparison, the group table, and the filters for dates, priority and people.


---

# 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/reports/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.
