> 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/product/features/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)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/dashboard.md).
{% endhint %}

The **dashboard** shows charts of task activity for the groups and dates people choose, without making a report file. On the web it is the first tab of **Dashboard & Reports**, beside the [Ops dashboard](https://docs.snapfix.com/product/features/reports/ops-dashboard.md), [Task reports](https://docs.snapfix.com/product/features/reports/task-reports.md) and [Asset reports](https://docs.snapfix.com/product/features/reports/asset-reports.md). It has seven panels: a task 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. The mobile apps have a smaller **Analytics** screen for one group or one **asset register**, built from the tasks already on the phone. iOS also keeps an older **legacy dashboard**, which shows only zeros.

## Rules

### Who can open it

* Any signed-in user can open the web dashboard. The page and its side-menu item have no role or plan check ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md)).
* The plan's dashboard switches (`webapp_dashboard_enabled`, `mobile_dashboard_enabled`) are stored, but no screen in the web or the apps reads them, so the plan does not limit the dashboard \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)] (web\_app\_v2 @ 0989b8e685, `paywall-helper.service.ts:117-120`; android @ 86068bfeea, `PaywallPermission.java:481`).
* The "Ops Dashboard" tab next to it shows only for role "Admin" on sites where the task dashboard is on ([Ops dashboard](https://docs.snapfix.com/product/features/reports/ops-dashboard.md)).
* The apps' Analytics has no role, permission or plan check either ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md)).

### What the web dashboard counts

* The panels count the tasks that match the filters, for the selected site. The defaults are active tasks, all three status colours, tasks created in the last month, and the user's own groups of the site ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#inputs)).
* An empty group selection counts every group again ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#inputs)).
* Every filter change, removed chip or "Clear all" reloads all seven panels ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#actions)).
* The comparison puts the chosen period next to the period of the same length before it ([`compare_summary_statuswise`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardcompare_summary_statuswise)).
* The status by day and the comparison need a date range; the web always sends one ([`status_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardstatus_summary)).
* The group table has a row only for groups with matching tasks. Its three status columns and "Interactions" count all of the group's tasks and chat entries, with no date filter; the "# New tasks", "# Progressed to yellow" and "# Moved to Green" columns count the matching tasks ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#layout)).
* The priority filter changes the dashboard's counts. The report files ignore it ([Report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields)).
* "Only includes tasks with cost" never changes the dashboard.
* The dashboard checks that the caller belongs to the site, but not to the groups the request names. A signed-in user who knows a group's ID can read its counts, and the map answer holds task titles and descriptions ([Report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields)).
* On load, the page sends the site's ID, name and customer type and the user's role to the survey tool \[[ASK-116](https://github.com/snapfix/docs/blob/main/ASK.md#ask-116-may-the-survey-tool-receive-users-contact-details-and-site-names)] ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#actions)).

### Analytics in the apps

* Analytics covers one group or one asset register. It is not offered for rooms or areas ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md)).
* It counts the tasks of the list it was opened from, with that list's search, filters and date range, and reads only the phone's copy. It has no filters of its own and makes no request to the server ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md#inputs)).
* For an asset register it leaves out the tag folder sections ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md#layout)).
* Its card that points to the web analytics leads to a page that does not exist on iOS, and its button is hidden on Android ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md#actions)).

## Flow

```mermaid
flowchart TD
    open["Open the Dashboard tab"] --> groups["Load the user's groups of the site"]
    groups --> panels["Seven panels load, one request each"]
    filter["Change a filter, remove a chip or Clear all"] --> panels
    panels --> expand["Expand a group, user or tag table: 25 rows a page"]
    panels --> pin["Click a map pin, then the task title"]
    pin --> task["Open the task"]
    app["App: Analytics from a group's or register's list"] --> device["Count the tasks already on the phone"]
    device --> noserver["No request to the server"]
```

## Platforms

| Capability                              | Web                         | iOS                                        | Android                        |
| --------------------------------------- | --------------------------- | ------------------------------------------ | ------------------------------ |
| Dashboard with seven panels and filters | Yes                         | No                                         | No                             |
| Analytics for one group                 | No                          | Yes, the group's view menu                 | Yes, the group's view sheet    |
| Analytics for one asset register        | No                          | Yes, the asset list's menu                 | Yes, the asset list's "+" menu |
| Map of task locations                   | Yes                         | Yes, in Analytics                          | Yes, in Analytics              |
| Expand a table                          | Yes: groups, users and tags | No                                         | No                             |
| Works offline                           | No                          | Yes                                        | Yes                            |
| Older group dashboard                   | No                          | Legacy dashboard, from a hidden bottom bar | No                             |

## Screens

* [Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md): web.
* [Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md): iOS and Android.
* [Legacy dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/legacy-dashboard.md): iOS.

## API and data

* [Reports API](https://docs.snapfix.com/engineering-reference/api/reports.md), one request per panel: [`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) and [`tag_summary`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-webdashboardtag_summary). They all take the [report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields), with the apipy differences listed there.
* The groups for the filter: [`GET /v1/app/businesses`](https://docs.snapfix.com/engineering-reference/api/groups.md#get-v1appbusinesses).
* A map pin's task: [`GET /v1/app/tasks/{uuid}`](https://docs.snapfix.com/engineering-reference/api/tasks.md#get-v1apptasksuuid).
* The apps' Analytics makes no request.
* Tables: [`tPri_Job`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_job.md) (the tasks counted) and [`tPri_Business`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_business.md) (the groups).

## Depends on

* [Tasks](https://docs.snapfix.com/product/features/tasks/tasks.md): the tasks counted, and their status colours.
* [Task lists](https://docs.snapfix.com/product/features/tasks/task-lists.md): the shared filter drawer and banner, and the list whose tasks the apps' Analytics counts.
* [Groups](https://docs.snapfix.com/product/features/groups/groups.md) and [Asset registers](https://docs.snapfix.com/product/features/assets/asset-registers.md): the groups and registers in the filters and in Analytics.
* [Site tags](https://docs.snapfix.com/product/features/console/site-tags.md): the tag folders in the tag table and the apps' top tags.
* [Switching sites](https://docs.snapfix.com/product/features/groups/site-switching.md): the selected site; with a multi-site, the page header has a site selector.
* [Task reports](https://docs.snapfix.com/product/features/reports/task-reports.md), [Asset reports](https://docs.snapfix.com/product/features/reports/asset-reports.md) and [Ops dashboard](https://docs.snapfix.com/product/features/reports/ops-dashboard.md): the other tabs of Dashboard & Reports.
* [Feedback surveys](https://docs.snapfix.com/product/features/notifications/feedback-surveys.md): the survey shown when the page opens \[[ASK-116](https://github.com/snapfix/docs/blob/main/ASK.md#ask-116-may-the-survey-tool-receive-users-contact-details-and-site-names)].

## Edge cases

* **No matching task:** the task summary shows zeros and the tables "No data available". When an assignee or asset filter matches no task, the API answers "no jobs found", and the status chart keeps the previous filter's lines ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#states)).
* **Errors:** no panel shows an error message. A failed summary shows zeros and a failed table "No data available"; only the status chart keeps its old lines ([Dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/dashboard.md#states)).
* **Large sites:** each summary loads every matching task and counts it in memory, with no limit.
* **Map pins:** when the task cannot be read, the link goes to a route that does not exist, and the app opens Fix instead. While Google Maps has not loaded, the map asks for its data every 200 ms, also after the user leaves the page.
* **Several sites:** the dashboard counts one site at a time; with a multi-site selected, the header's site selector picks it.
* **Apps, paged lists:** Android first loads every matching task ID for each colour, with "Please wait..." ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/reports/analytics.md#inputs)).
* **Offline:** the apps' Analytics works without a connection; only its web link and the map tiles need one. The web dashboard needs a connection.
* **Legacy iOS dashboard:** it shows zeros and empty sections for every group, because the code that fills it never runs ([Legacy dashboard](https://docs.snapfix.com/how-the-apps-work/screens/reports/legacy-dashboard.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/product/features/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.
