> 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/task-reports.md).

# Task reports

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

**Task reports** are spreadsheet and PDF files made from the tasks people filter. On the web, the "Task Reports" tab of **Dashboard & Reports** makes six types: "Multi-Task Report (export)", "Multi-Task Report (PDF)", "Completed tasks by user report", "Time report", "Checklist report" and "Inspection report". The server builds each file in the background, and "Your reports" lists the user's reports of the last 30 days, to download or delete. The apps have no report list: their task lists make a PDF of a group's, room's or area's tasks, and checklist and completed-task exports, and a task makes its own report from its share action.

## Rules

### Making a report on the web

* A report covers the tasks in the filters, which are the [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md) filters. An empty group selection means every group again. "Create" is not drawn while the site has no group loaded ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#inputs)).
* "Create" stays off until a report type is picked ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#inputs)).
* Creating needs the group permission `perJobReportGenerate` in every group of the filters. The web checks it and names the first group that lacks it; the group's name goes into the alert as HTML. The report actions do not check it, nor that the user belongs to the groups ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#dialogs-and-sheets)).
* The plan does not limit the web's report types: each type names a plan switch, but the web never reads it \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)] ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#inputs)).
* The checklist and inspection reports work only for tasks with checklists ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#inputs)).
* The priority filter does not change any file, because the report actions do not read the field the web sends ([Report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields)).
* A report is queued: the server answers at once with a report row, then builds the file after the answer ([Reports API](https://docs.snapfix.com/engineering-reference/api/reports.md#common-side-effects)).

### The list

* "Your reports" holds the user's reports of the last 30 days, whatever the filters say, ten a page. The server sends all of them in one answer ([`user_reports`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionuser_reports)).
* Older reports drop off the list, but nothing deletes them or their files, and the page does not say so \[[ASK-120](https://github.com/snapfix/docs/blob/main/ASK.md#ask-120-should-the-report-pages-say-how-long-reports-stay)].
* Single-task reports made from a task's share dialog appear in the same list ([Share task](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#share-task)).
* While a report made in the last 24 hours is below 100%, the page asks for the list again every 8 seconds. A failed report stays below 100%, so it keeps the polling going for a day ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#states)).
* "Download" works only at 100%. For a pending or failed report it does nothing. A report with no matching task ends as "NO TASKS FOUND" ([Report object](https://docs.snapfix.com/engineering-reference/api/reports.md#report-object)).
* Report files are public: anyone with the link can open them. A signed-in user who knows another user's ID can get that user's report links from the list.
* Only the report's owner deletes it. The row is marked deleted and the file stays on the server ([`delete_user_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actiondelete_user_report)).
* The list names a report by its stored type, so a PDF multi-task report shows as "Multi tasks report" ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#layout)).

### In the apps

* A group's, room's or area's task list has "Share Multi Task Report (PDF)". It sends the listed tasks and gets the file's link at once; the server builds the PDF after the answer ([`business_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionbusiness_job_report)).
* The apps' task list menus also have a checklist export and the "Tasks Completed Report", which are built while the app waits ([`checklist_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionchecklist_report), [`export_jobs_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionexport_jobs_report)).
* The apps dim the report items that the plan leaves out: four switches are read. On iOS a tap shows "Not included in this business account"; on Android it shows the package alert \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)] (ios @ aa31967ac8, `TaskListingOverflowMenuVC.swift:377-389`, `:493-494`; android @ 86068bfeea, `MoreOptionBottomSheet.java:260-288`).
* A task's own report is refused for a large task: more than 50 drawings, images and videos in its chat, or more than 100 checklist items. The message points to the web app ([`get_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionget_job_report)).
* A single-task report is marked completed even when its PDF fails. The task report pages behind it need only the task's ID.

## Flow

```mermaid
flowchart TD
    filters["Set the filters"] --> pick["Pick a report type"]
    pick --> create["Create"]
    create --> perm{"Report permission in every selected group?"}
    perm -- no --> alert["Alert names the group"]
    perm -- yes --> queued["Report row added, file built after the answer"]
    queued --> poll["The list asks again every 8 seconds"]
    poll --> done["100%: Download"]
    poll --> failed["Failure, such as NO TASKS FOUND: Download does nothing"]
    done --> remove["Owner deletes it from the list"]
```

## Platforms

| Capability                                             | Web                                                                                                                                | iOS                                    | Android                                |
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -------------------------------------- |
| Six report types from the filters, with "Your reports" | Yes                                                                                                                                | No                                     | No                                     |
| Multi-task PDF of a group, room or area                | From the task list's "Share Multi Task Report (PDF)", and the "Multi-Task Report (PDF)" type                                       | Task list menu, dimmed by the plan     | Task list menu, greyed by the plan     |
| Checklist and completed-task exports                   | "Checklist report" and "Completed tasks by user report"                                                                            | Task and asset list menus              | Task and asset list menus              |
| Single-task report                                     | Task share dialog, listed in "Your reports"                                                                                        | From the task's chat and asset details | From the task's chat and asset screens |
| Plan limits on report items                            | None \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)] | Four report items                      | Four report items                      |

## Screens

* [Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md): web.
* [Group tasks](https://docs.snapfix.com/how-the-apps-work/screens/tasks/group-tasks.md): the task lists whose menus hold the apps' report items.
* [Task detail](https://docs.snapfix.com/how-the-apps-work/screens/tasks/task-detail.md#share-task): the single-task report.

## API and data

* The six web types, each with the [report filter fields](https://docs.snapfix.com/engineering-reference/api/reports.md#report-filter-fields): [`report_task_detail_excel`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionreport_task_detail_excel), [`multi_tasks_report_pdf`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionmulti_tasks_report_pdf), [`completed_tasks_report_excel`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actioncompleted_tasks_report_excel), [`report_time_excel`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionreport_time_excel), [`checklist_report_excel`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionchecklist_report_excel) and [`inspection_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actioninspection_report).
* The list and delete: [`user_reports`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionuser_reports) and [`delete_user_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actiondelete_user_report). Each row is a [Report object](https://docs.snapfix.com/engineering-reference/api/reports.md#report-object).
* Single-task reports: [`job_report_v2`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionjob_report_v2) (web) and [`get_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionget_job_report) (apps).
* The apps' task list reports: [`business_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionbusiness_job_report), [`room_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionroom_job_report), [`area_job_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionarea_job_report), [`checklist_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionchecklist_report) and [`export_jobs_report`](https://docs.snapfix.com/engineering-reference/api/reports.md#post-actionexport_jobs_report).
* Tables: [`report_userreports`](https://docs.snapfix.com/engineering-reference/db/tables/report_userreports.md), one row per queued report.

## Depends on

* [Task lists](https://docs.snapfix.com/product/features/tasks/task-lists.md): the filters, which go with each report.
* [Tasks](https://docs.snapfix.com/product/features/tasks/tasks.md): the tasks and fields in the files.
* [Checklists](https://docs.snapfix.com/product/features/checklists/checklists.md) and [Inspections](https://docs.snapfix.com/product/features/housekeeping/inspections.md): the checklist and inspection reports.
* [Time and cost](https://docs.snapfix.com/product/features/tasks/time-and-cost.md): the time report and the cost filter.
* [Task sharing](https://docs.snapfix.com/product/features/tasks/task-sharing.md): the single-task report and the apps' multi-task PDF are share actions.
* [Group members](https://docs.snapfix.com/product/features/groups/group-members.md): the `perJobReportGenerate` permission in each group.
* [Subscriptions](https://docs.snapfix.com/product/features/billing/subscriptions.md): the plan switches the apps read \[[ASK-23](https://github.com/snapfix/docs/blob/main/ASK.md#ask-23-should-plan-limits-be-enforced-on-the-web-and-the-server)].
* [Asset reports](https://docs.snapfix.com/product/features/reports/asset-reports.md) and [Site reports](https://docs.snapfix.com/product/features/reports/site-reports.md): the same layout and list.

## Edge cases

* **No matching task:** the report ends as "NO TASKS FOUND", and its "Download" does nothing.
* **The apps' group PDFs:** they write a report row that nothing updates, so it stays new. The apps' task reports write rows whose link is the report page, not the file.
* **Filters and the list:** a filter change empties and reloads the list, but the list never follows the filters ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#actions)).
* **Errors:** a failed list load looks empty; a failed create or delete shows the server's message ([Task reports](https://docs.snapfix.com/how-the-apps-work/screens/reports/task-reports.md#states)).
* **Old reports:** a report older than 30 days is no longer listed, and its file stays reachable by its link \[[ASK-120](https://github.com/snapfix/docs/blob/main/ASK.md#ask-120-should-the-report-pages-say-how-long-reports-stay)].
* **Several sites:** the filters cover the selected site's groups; with a multi-site, the header's site selector picks the site.


---

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