---
title: "Create a scheduled custom report"
method: POST
path: "/ng-reports/scheduled/custom"
tags: ["NG Reports (Scheduled)"]
---

# Create a scheduled custom report

`POST /ng-reports/scheduled/custom`

Create a new scheduled custom report with the provided details.

## Request body

- XiqCustomReportRequest
  - `metrics` XiqQoeDiagnosticsMetrics[], required — List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).
  - `report_name` string, required — The name of the report.
  - `report_description` string — A short description of the report.
  - `site_ids` integer[] — List of site IDs the report will cover.
  - `building_ids` integer[] — List of building IDs the report will cover.
  - `floor_ids` integer[] — List of floor IDs the report will cover.
  - `ssids` string[] — List of SSIDs to be included in the report.
  - `bands` XiqDiagnosticsBands[] — List of bands (e.g., 2.4GHz, 5GHz) to be covered in the report.
  - `recipients` XiqRecipientCnsInfo[] — List of recipient email to send the report.
    - `email` string — The recipient email address
    - `notifier_id` integer — Unique identifier generated by CNS(Common Notification Service) for an email recipient. When a recipient is subscribed to a report, the UI verifies the email with CNS. If the recipient does not exist, CNS creates a new entry and generates this Notifier ID, which is required by the Report Service for validation. This field is mandatory to prevent non-verified or non-existent email addresses from being subscribed via xAPI. The Notifier ID for an email can be found in the CNS Swagger. Refer to the CNS Swagger UI for the applicable environment: https://<cns-url>/notification/swagger-ui/index.html#/ example(non-prod) - https://g2-eu-cns.qa.xcloudiq.com/notification/swagger-ui/index.html#/
  - `schedules` XiqReportScheduleRequest[], required — List of schedules (e.g., daily, weekly, etc.).
    - `frequency_type` 'DAILY' | 'WEEKLY' | 'MONTHLY', required — The frequency type of the scheduled report (e.g., DAILY, WEEKLY, etc.).
    - `schedule_time` string — The scheduled time in HH:MM format (e.g., 08:00).
    - `schedule_timezone` string — The timezone of the scheduled report.
    - `schedule_days` integer[], required — Days on which the report is scheduled (e.g., [0] for Sunday).
    - `enable_schedule` boolean — Whether the schedule is enabled or not.
  - `file_format` XiqReportFileFormat[], required — The file format(s) of the report (e.g., PDF, CSV).

## Response `200`

OK

- XiqCustomReportResponse
  - `report_id` integer — Unique ID of the report
  - `report_name` string — The name of the actual report.
  - `report_description` string — A short description of the report.
  - `metrics` XiqQoeDiagnosticsMetrics[], required — List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).
  - `site_ids` integer[] — List of site IDs the report will cover.
  - `building_ids` integer[] — List of building IDs the report will cover.
  - `floor_ids` integer[] — List of floor IDs the report will cover.
  - `ssids` string[] — List of SSIDs to be included in the report.
  - `bands` XiqDiagnosticsBands[] — List of bands (e.g., 2.4GHz, 5GHz) to be included in the report.
  - `recipients` XiqRecipientCnsInfo[] — List of recipient email to send the report.
    - `email` string — The recipient email address
    - `notifier_id` integer — Unique identifier generated by CNS(Common Notification Service) for an email recipient. When a recipient is subscribed to a report, the UI verifies the email with CNS. If the recipient does not exist, CNS creates a new entry and generates this Notifier ID, which is required by the Report Service for validation. This field is mandatory to prevent non-verified or non-existent email addresses from being subscribed via xAPI. The Notifier ID for an email can be found in the CNS Swagger. Refer to the CNS Swagger UI for the applicable environment: https://<cns-url>/notification/swagger-ui/index.html#/ example(non-prod) - https://g2-eu-cns.qa.xcloudiq.com/notification/swagger-ui/index.html#/
  - `schedules` XiqReportSchedule[], required — List of schedules (e.g., daily, weekly, etc.).
    - `report_schedule_id` integer — The unique ID of the scheduled report.
    - `frequency_type` 'DAILY' | 'WEEKLY' | 'MONTHLY' — The frequency type of the scheduled report (e.g., DAILY, WEEKLY, etc.).
    - `schedule_time` string — The scheduled time in HH:MM:SS format (e.g., 08:00:00).
    - `schedule_timezone` string — The timezone of the scheduled report.
    - `schedule_days` integer[] — Days on which the report is scheduled (e.g., [0] for Sunday).
    - `enable_schedule` boolean — Whether the schedule is enabled or not.
  - `file_format` XiqReportFileFormat[], required — The file format(s) of the report (e.g., PDF, CSV).

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)