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

# Report schedule

Deliver a report to a user's mailbox on a repeating schedule.

A report schedule runs a [report](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md) on a repeating basis and emails the result, so a weekly mileage summary arrives without anyone asking for it.

A schedule holds the same report definition that [`report/tracker/generate`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-generate) takes, plus when to run it and where to send it.

## Schedule entry object

## The ReportScheduleEntry object

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"components":{"schemas":{"ReportScheduleEntry":{"type":"object","description":"A report that is generated regularly and emailed.","properties":{"id":{"type":"integer","description":"Schedule ID. **Ignored on create.**"},"enabled":{"type":"boolean","description":"Whether the scheduled report is active."},"parameters":{"type":"object","description":"What to generate, how often, and where to send it.","properties":{"period":{"type":"string","description":"How much time each report covers: `Xm` for months, `w` for a week, `d` for a day, `y` for a year."},"schedule":{"type":"object","description":"When the report fires.","properties":{"type":{"type":"string","description":"Which form the schedule takes.","enum":["weekdays","month_days"]},"weekdays":{"type":"array","description":"Days of the week to fire on, where 1 is Monday and 7 is Sunday.","items":{"type":"integer","minimum":1,"maximum":7}},"month_days":{"type":"array","description":"Days of the month to fire on, from 1 to 31.","items":{"type":"integer","minimum":1,"maximum":31}}}},"report":{"type":"object","description":"The report to generate. Takes the same fields as `report/tracker/generate`, except the period, which comes from `period` above. Includes `include_places_in_address` and `include_zones_in_address`, both defaulting to `true`.","additionalProperties":true},"emails":{"type":"array","description":"Optional. Addresses to send the report to.","items":{"type":"string"}},"email_format":{"type":"string","description":"Format to send the report in.","enum":["pdf","xls"]},"email_zip":{"type":"boolean","description":"Whether to compress the attachment."},"sending_time":{"type":"string","description":"Optional. Default `00:00:00`. Local time to send at, to **hourly granularity**."}}},"fire_time":{"type":"string","description":"When the schedule last fired. **Ignored on create and update.**"},"last_result":{"type":"object","description":"How the last generation went. **Ignored on create and update.**","properties":{"success":{"type":"boolean","description":"Whether the last report generated successfully."},"id":{"type":"integer","description":"ID of the report that was generated."}}}}}}}}
```

The `report` block takes the same parameters as [`report/tracker/generate`](/docs/navixy-api/user-api/resources/commons/report/report_tracker.md#post-report-tracker-generate), including the optional `include_places_in_address` and `include_zones_in_address` flags. Both are boolean and default to `true`, and they decide whether place and geofence names are prefixed to addresses in the generated report.

## API actions

API base path: `/report/schedule`.

Every operation on this page requires the `reports` sub-user right.

***

## Create report schedule

> Create a schedule that generates a report regularly and emails it, and return its ID.\
> \
> The \`parameters.report\` block takes the same fields as \`report/tracker/generate\`, minus the period, which comes from \`parameters.period\` instead.\
> \
> Requires the \`reports\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Reports","description":"Generating tracker reports, fetching them as JSON or as files, and scheduling them to be emailed regularly. All resources under the /report/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"ReportScheduleEntry":{"type":"object","description":"A report that is generated regularly and emailed.","properties":{"id":{"type":"integer","description":"Schedule ID. **Ignored on create.**"},"enabled":{"type":"boolean","description":"Whether the scheduled report is active."},"parameters":{"type":"object","description":"What to generate, how often, and where to send it.","properties":{"period":{"type":"string","description":"How much time each report covers: `Xm` for months, `w` for a week, `d` for a day, `y` for a year."},"schedule":{"type":"object","description":"When the report fires.","properties":{"type":{"type":"string","description":"Which form the schedule takes.","enum":["weekdays","month_days"]},"weekdays":{"type":"array","description":"Days of the week to fire on, where 1 is Monday and 7 is Sunday.","items":{"type":"integer","minimum":1,"maximum":7}},"month_days":{"type":"array","description":"Days of the month to fire on, from 1 to 31.","items":{"type":"integer","minimum":1,"maximum":31}}}},"report":{"type":"object","description":"The report to generate. Takes the same fields as `report/tracker/generate`, except the period, which comes from `period` above. Includes `include_places_in_address` and `include_zones_in_address`, both defaulting to `true`.","additionalProperties":true},"emails":{"type":"array","description":"Optional. Addresses to send the report to.","items":{"type":"string"}},"email_format":{"type":"string","description":"Format to send the report in.","enum":["pdf","xls"]},"email_zip":{"type":"boolean","description":"Whether to compress the attachment."},"sending_time":{"type":"string","description":"Optional. Default `00:00:00`. Local time to send at, to **hourly granularity**."}}},"fire_time":{"type":"string","description":"When the schedule last fired. **Ignored on create and update.**"},"last_result":{"type":"object","description":"How the last generation went. **Ignored on create and update.**","properties":{"success":{"type":"boolean","description":"Whether the last report generated successfully."},"id":{"type":"integer","description":"ID of the report that was generated."}}}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/report/schedule/create":{"post":{"tags":["Reports"],"summary":"Create report schedule","description":"Create a schedule that generates a report regularly and emails it, and return its ID.\n\nThe `parameters.report` block takes the same fields as `report/tracker/generate`, minus the period, which comes from `parameters.period` instead.\n\nRequires the `reports` right.","operationId":"reportScheduleCreate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"allOf":[{"$ref":"#/components/schemas/ReportScheduleEntry"}],"description":"The schedule to create, without `id`, `fire_time` or `last_result`."}},"required":["schedule"]}}}},"responses":{"200":{"description":"The created schedule","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"id":{"type":"integer","description":"ID of the new schedule entry."}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: one of the trackers is on a plan with reports disabled.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 217: one or more tracker IDs do not exist or belong to another user. Error 222: the report plugin was not found.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 217 - List contains nonexistent entities, when a tracker ID belongs to no tracker or to another user's.
* 222 - Plugin not found, when no report plugin has the given ID.
* 236 - Feature unavailable due to tariff restrictions.

***

## Update report schedule

> Update a report schedule. Pass a full schedule object including its \`id\`.\
> \
> \`fire\_time\` and \`last\_result\` are ignored: both are set by the platform.\
> \
> Requires the \`reports\` right.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Reports","description":"Generating tracker reports, fetching them as JSON or as files, and scheduling them to be emailed regularly. All resources under the /report/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"ReportScheduleEntry":{"type":"object","description":"A report that is generated regularly and emailed.","properties":{"id":{"type":"integer","description":"Schedule ID. **Ignored on create.**"},"enabled":{"type":"boolean","description":"Whether the scheduled report is active."},"parameters":{"type":"object","description":"What to generate, how often, and where to send it.","properties":{"period":{"type":"string","description":"How much time each report covers: `Xm` for months, `w` for a week, `d` for a day, `y` for a year."},"schedule":{"type":"object","description":"When the report fires.","properties":{"type":{"type":"string","description":"Which form the schedule takes.","enum":["weekdays","month_days"]},"weekdays":{"type":"array","description":"Days of the week to fire on, where 1 is Monday and 7 is Sunday.","items":{"type":"integer","minimum":1,"maximum":7}},"month_days":{"type":"array","description":"Days of the month to fire on, from 1 to 31.","items":{"type":"integer","minimum":1,"maximum":31}}}},"report":{"type":"object","description":"The report to generate. Takes the same fields as `report/tracker/generate`, except the period, which comes from `period` above. Includes `include_places_in_address` and `include_zones_in_address`, both defaulting to `true`.","additionalProperties":true},"emails":{"type":"array","description":"Optional. Addresses to send the report to.","items":{"type":"string"}},"email_format":{"type":"string","description":"Format to send the report in.","enum":["pdf","xls"]},"email_zip":{"type":"boolean","description":"Whether to compress the attachment."},"sending_time":{"type":"string","description":"Optional. Default `00:00:00`. Local time to send at, to **hourly granularity**."}}},"fire_time":{"type":"string","description":"When the schedule last fired. **Ignored on create and update.**"},"last_result":{"type":"object","description":"How the last generation went. **Ignored on create and update.**","properties":{"success":{"type":"boolean","description":"Whether the last report generated successfully."},"id":{"type":"integer","description":"ID of the report that was generated."}}}}}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/report/schedule/update":{"post":{"tags":["Reports"],"summary":"Update report schedule","description":"Update a report schedule. Pass a full schedule object including its `id`.\n\n`fire_time` and `last_result` are ignored: both are set by the platform.\n\nRequires the `reports` right.","operationId":"reportScheduleUpdate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"schedule":{"allOf":[{"$ref":"#/components/schemas/ReportScheduleEntry"}],"description":"The schedule to update, including its `id`, and without `fire_time` or `last_result`."}},"required":["schedule"]}}}},"responses":{"200":{"description":"Schedule updated","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"402":{"description":"Error 236: one of the trackers is on a plan with reports disabled.","$ref":"#/components/responses/ResponseError"},"403":{"description":"Error 217: one or more tracker IDs do not exist or belong to another user. Error 222: the report plugin was not found.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 217 - List contains nonexistent entities, when a tracker ID belongs to no tracker or to another user's.
* 222 - Plugin not found, when no report plugin has the given ID.
* 236 - Feature unavailable due to tariff restrictions, when a device's tariff does not allow reports.

***

## List report schedules

> List the report schedules of the current user.\
> \
> Requires the \`reports\` right.\
> \
> Callable with an empty body. Also accepts GET.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Reports","description":"Generating tracker reports, fetching them as JSON or as files, and scheduling them to be emailed regularly. All resources under the /report/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"schemas":{"ReportScheduleEntry":{"type":"object","description":"A report that is generated regularly and emailed.","properties":{"id":{"type":"integer","description":"Schedule ID. **Ignored on create.**"},"enabled":{"type":"boolean","description":"Whether the scheduled report is active."},"parameters":{"type":"object","description":"What to generate, how often, and where to send it.","properties":{"period":{"type":"string","description":"How much time each report covers: `Xm` for months, `w` for a week, `d` for a day, `y` for a year."},"schedule":{"type":"object","description":"When the report fires.","properties":{"type":{"type":"string","description":"Which form the schedule takes.","enum":["weekdays","month_days"]},"weekdays":{"type":"array","description":"Days of the week to fire on, where 1 is Monday and 7 is Sunday.","items":{"type":"integer","minimum":1,"maximum":7}},"month_days":{"type":"array","description":"Days of the month to fire on, from 1 to 31.","items":{"type":"integer","minimum":1,"maximum":31}}}},"report":{"type":"object","description":"The report to generate. Takes the same fields as `report/tracker/generate`, except the period, which comes from `period` above. Includes `include_places_in_address` and `include_zones_in_address`, both defaulting to `true`.","additionalProperties":true},"emails":{"type":"array","description":"Optional. Addresses to send the report to.","items":{"type":"string"}},"email_format":{"type":"string","description":"Format to send the report in.","enum":["pdf","xls"]},"email_zip":{"type":"boolean","description":"Whether to compress the attachment."},"sending_time":{"type":"string","description":"Optional. Default `00:00:00`. Local time to send at, to **hourly granularity**."}}},"fire_time":{"type":"string","description":"When the schedule last fired. **Ignored on create and update.**"},"last_result":{"type":"object","description":"How the last generation went. **Ignored on create and update.**","properties":{"success":{"type":"boolean","description":"Whether the last report generated successfully."},"id":{"type":"integer","description":"ID of the report that was generated."}}}}}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/report/schedule/list":{"post":{"tags":["Reports"],"summary":"List report schedules","description":"List the report schedules of the current user.\n\nRequires the `reports` right.\n\nCallable with an empty body. Also accepts GET.","operationId":"reportScheduleList","responses":{"200":{"description":"The schedules","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"$ref":"#/components/schemas/ReportScheduleEntry"}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

***

## Delete report schedule

> Delete a report schedule. Reports it has already generated are left alone.\
> \
> Requires the \`reports\` right.\
> \
> Also accepts GET with the same parameters as query-string values.

```json
{"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Reports","description":"Generating tracker reports, fetching them as JSON or as files, and scheduling them to be emailed regularly. All resources under the /report/ path."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/report/schedule/delete":{"post":{"tags":["Reports"],"summary":"Delete report schedule","description":"Delete a report schedule. Reports it has already generated are left alone.\n\nRequires the `reports` right.\n\nAlso accepts GET with the same parameters as query-string values.","operationId":"reportScheduleDelete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"schedule_id":{"type":"integer","description":"ID of the report schedule to delete.","minimum":1}},"required":["schedule_id"]}}}},"responses":{"200":{"description":"Schedule deleted","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}}
```

#### Errors

These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes):

* 201 - Not found in the database, when no schedule has the given ID.


---

# 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://navixy.com/docs/navixy-api/user-api/resources/commons/report/report_schedule.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.