> 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/staff/usage-dashboards.md).

# Usage dashboards

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

Snapfix staff follow how customers use Snapfix in four pages of the [staff admin app](https://docs.snapfix.com/product/features/staff/staff-admin.md). The **account dashboard** shows each month's active users, tasks, scheduled tasks and other activity for the sites staff pick. The **CS dashboard** (customer success) lists the paying sites with their dates, **risk score**, users, groups and activity, and makes two spreadsheets: an activity report and a user list. **Analytics** maps where one site's tasks are. The **security dashboard** links to monthly Google Sheets built from BigQuery data. Staff use them to see which customers are active, which are at risk and who to follow up. A customer's own charts are a different feature: [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md).

## Rules

### Who can see them

* Every staff session opens all four pages; the pages check no role ([Staff screens](https://docs.snapfix.com/how-the-apps-work/screens/staff.md#access)).
* The calls behind them check no staff flag on the server, so any signed-in Snapfix user could read every paying site's monthly figures, the CS table with the site admins' contact details, and the task names and positions of any group. Any signed-in user can start the reports for all the sites they cover.

### Account dashboard

* Staff pick one or more sites and a date range, then press "Get"; nothing loads before. "Get" needs at least one site and a range ([Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md#inputs)).
* The range starts on the first day of the month six months ago and ends on the last day of last month. Dates after today cannot be picked, and the length of the range has no limit. The dates are sent as calendar days ([Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md#inputs)).
* Each site is one row with its name, stored customer type and first invoice date; expanding it shows the site's months: active and unique users, tasks, scheduled tasks and the activity by kind ([Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md#layout)).
* The monthly columns line up only while the server returns every list in the same month order ([Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md#layout)).

### CS dashboard

* The table has one row per live site whose customer type starts with `paying_`, highest risk score first. Its banner says "This CS Dashboard is for ANNUAL accounts only", but nothing limits it to annual accounts \[[ASK-206](https://github.com/snapfix/docs/blob/main/ASK.md#ask-206-should-the-cs-dashboard-list-annual-accounts-only)] ([CS dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md#layout)).
* It shows at first the first invoice, renewal and created dates, the risk score (with its unit, such as "40%"), the active groups and the activity; more columns can be shown. Searches and sorts work on the loaded rows ([CS dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md#layout)).
* The server keeps a copy of the table and rebuilds it when the copy is more than 12 hours old, so the figures can be up to 12 hours old ([`GET /cs-dashboard`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-cs-dashboard)). A copy with the site admins' contact details is tracked in apipy's git repository.
* The activity counts cover January 2019 to December 2023 only, so nothing since 2024 counts, and "Schedules" and "Reports" are always 0.
* **Activity report:** a spreadsheet of task chat messages per day, with each site's risk score, for every live site of type `paying_customer`, `churn`, `investor_probono` or `sales_trial`. The end date is yesterday at the latest and the start defaults to seven days before today. The pickers mean to keep the range within three months, but the limit is not enforced ([Activity Report](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md#activity-report), [`kpi_job_chats_created_day_xlsx_v2_webadmin`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionkpi_job_chats_created_day_xlsx_v2_webadmin)).
* **User list report:** a spreadsheet of the users of the paying and sales-trial sites, with their email addresses and mobile numbers ([User List Report](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md#user-list-report)).
* Both reports are built after the answer: the dialog shows the file's link and says it may take one or two minutes to appear. The files get random names, but each opens for anyone who has its link. Whether such files may be public is open \[[ASK-115](https://github.com/snapfix/docs/blob/main/ASK.md#ask-115-can-compliance-documents-report-files-and-the-comply-report-be-opened-from-their-link-without-signing-in)].

### Analytics

* Staff pick one site; the first site of the list is picked when the page opens. The map shows one pin per task that has a position, from the site's live task groups; asset registers and deleted groups are left out ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/staff/analytics.md#layout)).
* A pin follows the task's colour: green, red and yellow pins, amber with the yellow one, and no pin image for any other value. Close pins form clusters, and a pin opens the task's details ([Analytics](https://docs.snapfix.com/how-the-apps-work/screens/staff/analytics.md#layout)).
* Switching sites quickly can mix the earlier site's pins into the new site's map.
* The page loads Google Maps with a key written into the app's code and a clustering script from a public CDN with no version pinned.

### Security dashboard

* The page lists two sections, "Security Dashboard" and "Registration & Active User", each with one Google Sheet link per month. The list is built into the app and calls no API ([Security dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/security-dashboard.md)).
* The list stops at 2023-12 \[[ASK-216](https://github.com/snapfix/docs/blob/main/ASK.md#ask-216-should-the-security-dashboard-list-months-after-2023-12)]. The file is also in the app's public assets, so anyone can read the links; whether the sheets themselves are shared beyond staff is not recorded \[[ASK-215](https://github.com/snapfix/docs/blob/main/ASK.md#ask-215-who-can-open-the-security-dashboards-sheets)].

### Other usage figures

* The Account page's graph shows a site's task chat messages per day, though it labels them sales ([Customer administration](https://docs.snapfix.com/product/features/staff/customer-admin.md)).
* authpy's `/looker/*` routes serve company-wide metrics, such as weekly active users, through php-apis's Looker actions, with the shared Basic login. The admin app does not call them, and which tool does is not in the repos \[[ASK-11](https://github.com/snapfix/docs/blob/main/ASK.md#ask-11-which-unused-api-endpoints-are-still-needed)] ([Looker metric object](https://docs.snapfix.com/engineering-reference/api/staff.md#looker-metric-object)).

## Flow

```mermaid
flowchart TD
  open["Staff opens a usage page"] --> which{"Which page?"}
  which -- "Account dashboard" --> pick["Pick sites and a date range, press Get"]
  pick --> months["One row per site; expand for its months"]
  which -- "CS dashboard" --> table["Paying sites, from a copy up to 12 hours old"]
  table --> report{"Generate a report?"}
  report -- "activity" --> act["Link to the activity spreadsheet"]
  report -- "user list" --> users["Link to the user list spreadsheet"]
  act --> wait["Open the link a minute or two later"]
  users --> wait
  which -- "Analytics" --> map["Pick a site: task pins on the map"]
  which -- "Security dashboard" --> sheets["Open a monthly Google Sheet"]
```

## Platforms

| Capability                       | Web                   | iOS | Android |
| -------------------------------- | --------------------- | --- | ------- |
| Account dashboard                | Yes, in the admin app | No  | No      |
| CS dashboard and its two reports | Yes, in the admin app | No  | No      |
| Analytics map                    | Yes, in the admin app | No  | No      |
| Security dashboard               | Yes, in the admin app | No  | No      |

## Screens

* [Account dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/account-dashboard.md): monthly usage for the picked sites and dates.
* [CS dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/cs-dashboard.md): the paying sites and the two reports.
* [Analytics](https://docs.snapfix.com/how-the-apps-work/screens/staff/analytics.md): one site's task pins on a map.
* [Security dashboard](https://docs.snapfix.com/how-the-apps-work/screens/staff/security-dashboard.md): the monthly sheet links.

## API and data

* Account dashboard: [`admin_dashboard_parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_dashboard_parents), with the site picker's [`GET /v4/parents`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-v4parents).
* CS dashboard: [`GET /cs-dashboard`](https://docs.snapfix.com/engineering-reference/api/staff.md#get-cs-dashboard); the reports [`kpi_job_chats_created_day_xlsx_v2_webadmin`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionkpi_job_chats_created_day_xlsx_v2_webadmin) and [`paying_sales_trial_account_users_webadmin`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionpaying_sales_trial_account_users_webadmin).
* Analytics: [`admin_read_pri_business`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionadmin_read_pri_business), then [`job_geo_stats`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionjob_geo_stats).
* Account graph: [`kpi_job_chats_created_day`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionkpi_job_chats_created_day).
* Looker metrics: the `?action=looker_*` actions, such as [`looker_wau`](https://docs.snapfix.com/engineering-reference/api/staff.md#post-actionlooker_wau).
* The security dashboard calls no API.
* Tables: [`tPri_Parent`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_parent.md) (the site, its customer type and dates), [`tPri_Business`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_business.md) and [`tPri_Job`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_job.md) (the groups and tasks behind the counts and pins), [`tPri_User`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_user.md) and [`tPri_UserBusiness`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_userbusiness.md) (the users in the user list report).

## Depends on

* [Customer administration](https://docs.snapfix.com/product/features/staff/customer-admin.md): the sites, their customer types, dates and groups.
* [Subscriptions](https://docs.snapfix.com/product/features/billing/subscriptions.md): the customer types that decide which sites the CS table and the reports include.
* [Task chat](https://docs.snapfix.com/product/features/chat/task-chat.md): the chat messages that the activity figures count.
* [Tasks](https://docs.snapfix.com/product/features/tasks/tasks.md), [Groups](https://docs.snapfix.com/product/features/groups/groups.md) and [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md): what the counts and pins are made of.
* [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md) and [Site reports](https://docs.snapfix.com/product/features/reports/site-reports.md): the customer-side charts and reports, a separate feature.
* Outside services: Google Maps, the clustering script's CDN, Google Sheets and BigQuery, and the Looker tool, none in the repos.

## Edge cases

* **Failed loads:** the tables show no message, so a failure looks like a result with no sites. A failed analytics load stops the spinner and shows no pins; a map script that fails to load leaves the map empty, with no message.
* **Nothing picked:** "Get" stays disabled and the account dashboard stays empty.
* **Stale figures:** the CS table can be up to 12 hours old, and its activity counts stop at 2023.
* **Dates:** the dashboards show dates with the week-numbering year, so a date near New Year can show the wrong year.
* **Several sites:** the account dashboard takes several sites at once, Analytics one, and the CS dashboard lists them all.
* **Time zones:** the account dashboard and the reports use calendar days; no page names a time zone.
* **Offline:** not applicable; the admin app is web only.


---

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