> 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/staff/account-dashboard.md).

# Account 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/staff/account-dashboard.md).
{% endhint %}

Staff pick one or more sites and a date range, and see each site's monthly usage: active users, tasks, scheduled tasks and other activity, with its first invoice date.

* **Where:** admin app `/account-dashboard`; menu "Account Dashboard"
* **Who:** anyone signed in to the admin app ([Access](https://docs.snapfix.com/how-the-apps-work/screens/staff.md#access)). The statistics call checks no staff flag on the server, so any signed-in user can read every paying site's figures ([`admin_dashboard_parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_dashboard_parents)).
* **Feature:** [Usage dashboards](https://docs.snapfix.com/product/features/staff/usage-dashboards.md)

## Layout

1. **Heading.** "Account Dashboard", and under it "You can select different account(s) to see their Analytics Data."
2. **Controls row.** The [account picker](https://docs.snapfix.com/how-the-apps-work/screens/staff.md#account-picker) in its multiple mode (placeholder "Type to search account"), a date range picker, and a "Get" button.
3. **Table.** Empty until "Get". One row per site, with an expand arrow and the columns "Name", "Customer Type" (the stored type, as it is, such as `paying_customer`) and "First Invoice Date", shown as `YYYY-MM-dd`. The table pages the loaded rows in the browser, with a page size selector and a quick jump box.
4. **Expanded row.** A monthly table with the columns "Month", "Active Users", "Unique Users", "Tasks", "Scheduled Tasks", "Excl31", "Follow Assign", "Manual", "NFC", "Scheduler", "Tags", "Timecost" and "Todo". The months come from the active users list; every other column shows the value at the same position in its own list, so the columns line up only while the server returns every list in the same month order.

## Inputs

| Field      | Type                     | Required       | Default                                                                      | Rules and messages                                                                             |
| ---------- | ------------------------ | -------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| Accounts   | Multi-select with search | Yes, for "Get" | Nothing selected                                                             | No message: "Get" stays disabled until at least one site is picked.                            |
| Date range | Date range picker        | Yes, for "Get" | From the first day of the month six months ago to the last day of last month | Dates after today cannot be picked. No limit on the length of the range. Sent as `YYYY-MM-DD`. |

"Get" is disabled while no site is picked, while the range is empty, and while a request runs.

## Actions

| Action       | Who              | What happens                                                                                                                                                               | API                                                                                                                                      |
| ------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Pick sites   | Anyone signed in | Searches and pages the site list ([account picker](https://docs.snapfix.com/how-the-apps-work/screens/staff.md#account-picker)). Nothing loads into the table until "Get". | [`GET /v4/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-v4parents)                                           |
| Get          | Anyone signed in | Clears the table and loads the figures for the picked sites and dates, asking for as many rows as sites were picked.                                                       | [`POST ?action=admin_dashboard_parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_dashboard_parents) |
| Expand a row | Anyone signed in | Shows that site's monthly table. The data is already loaded.                                                                                                               | None                                                                                                                                     |
| Change page  | Anyone signed in | Pages the loaded rows.                                                                                                                                                     | None                                                                                                                                     |

## States

* **Loading:** the table shows its spinner, and "Get" is disabled.
* **Empty:** before "Get", and when the answer holds no site, the table has no rows.
* **Error:** no message. A failed request, or an answer that is not a success, leaves the table empty, so it looks like a result with no sites.
* **No permission:** none in the app.


---

# 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/staff/account-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.
