Sign in
NG Reports (Scheduled)

Create a scheduled custom report

Create a new scheduled custom report with the provided details.

post/ng-reports/scheduled/custom

Request body

metricsXiqQoeDiagnosticsMetrics[] required

List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).

report_namestring required

The name of the report.

report_descriptionstring

A short description of the report.

site_idsinteger[]

List of site IDs the report will cover.

building_idsinteger[]

List of building IDs the report will cover.

floor_idsinteger[]

List of floor IDs the report will cover.

ssidsstring[]

List of SSIDs to be included in the report.

bandsXiqDiagnosticsBands[]

List of bands (e.g., 2.4GHz, 5GHz) to be covered in the report.

file_formatXiqReportFileFormat[] required

The file format(s) of the report (e.g., PDF, CSV).

Response

OK

report_idinteger

Unique ID of the report

report_namestring

The name of the actual report.

report_descriptionstring

A short description of the report.

metricsXiqQoeDiagnosticsMetrics[] required

List of metrics to include in the report (e.g., MAX_CONCURRENT_CLIENTS).

site_idsinteger[]

List of site IDs the report will cover.

building_idsinteger[]

List of building IDs the report will cover.

floor_idsinteger[]

List of floor IDs the report will cover.

ssidsstring[]

List of SSIDs to be included in the report.

bandsXiqDiagnosticsBands[]

List of bands (e.g., 2.4GHz, 5GHz) to be included in the report.

file_formatXiqReportFileFormat[] required

The file format(s) of the report (e.g., PDF, CSV).

Changes

Changed in 1 of the 6 revisions of this API.5

  • 242a0e1b1b405See the full diff
    • ▲

      the file_format request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the metrics request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the schedules request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the schedules/items/schedule_days request property's minItems was increased to 1

      request-property-min-items-increased

    • ▲

      the report_name request property's minLength was increased from 0 to 1

      request-property-min-length-increased

Of the 6 revisions, 1 has no diff computed.