> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/commons/report.md).

# Report

Generating tracker reports and delivering them on a schedule.

A report turns a period of tracking data into something a person reads. Generating one is asynchronous: the request starts a job, and the result is polled for and then retrieved or downloaded.

[Report tracker](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md) covers that cycle. [Report schedule](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md) covers having the Navixy platform mail a report out repeatedly instead.

For the report types available and the parameters each takes, see [Report plugins](/docs/navixy-api/user-api/resources/commons/plugin/report_plugins.md).

## Operations in this section

#### Report schedule

| Endpoint                                                                                                                       | Method | What it does           |
| ------------------------------------------------------------------------------------------------------------------------------ | ------ | ---------------------- |
| [`/report/schedule/create`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-create) | POST   | Create report schedule |
| [`/report/schedule/update`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-update) | POST   | Update report schedule |
| [`/report/schedule/list`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-list)     | POST   | List report schedules  |
| [`/report/schedule/delete`](/docs/navixy-api/user-api/resources/commons/report/report_schedule.md#post-report-schedule-delete) | POST   | Delete report schedule |

#### Report tracker

| Endpoint                                                                                                                        | Method | What it does      |
| ------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------- |
| [`/report/tracker/generate`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-generate) | POST   | Generate report   |
| [`/report/tracker/status`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-status)     | POST   | Get report status |
| [`/report/tracker/retrieve`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-retrieve) | POST   | Retrieve report   |
| [`/report/tracker/download`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-download) | POST   | Download report   |
| [`/report/tracker/list`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-list)         | POST   | List reports      |
| [`/report/tracker/delete`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-delete)     | POST   | Delete report     |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/resources/commons/report.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.