Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Extreme Networks NG Reports API

The NG Reports - On Demand Analytics and Scheduled Reporting

Extreme Networks NG Reports API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include NG Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 15 paths, and defines 29 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.

Requests are made against a single base URL, https://api.extremecloudiq.com.

17 operations 15 paths 29 schemas 1 DELETE4 GET11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Extreme Networks NG Reports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JSON Web Token (JWT) based authentication

Paths & Operations 17

Across 15 paths, the API surfaces 17 operations — 1 DELETE, 4 GET, 11 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

NG Reports 17

The NG Reports - On Demand Analytics and Scheduled Reporting

GET
/ng-reports/reports
Get scheduled reports
getScheduledReports 2 params → 200default
POST
/ng-reports/reports
Create a new scheduled report
createScheduledReport body → 201default
DELETE
/ng-reports/reports/{id}
Delete a scheduled report
deleteScheduledReport 1 param → 204default
PUT
/ng-reports/reports/{id}
Update an existing scheduled report
updateScheduledReport 1 param body → 200default
POST
/ng-reports/metrics/timeseries.yaml
Time Series data in NG Reports Metrics
timeseriesReportMetrics body → 200default
POST
/ng-reports/metrics/tabledata.yaml
Table Data data in NG Reports Metrics
tabledataReportMetrics body → 200default
POST
/ng-reports/metrics/metadata/ssid
Ssid filter metadata
getDiagnosticsSsidFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/os
Client Os filter metadata
getDiagnosticsOsFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/band
Band filter metadata
getDiagnosticsBandFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/client
Client filter metadata
getDiagnosticsClientFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/user
User filter metadata
getDiagnosticsUserFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/applications
Application filter metadata
getDiagnosticsApplicationFilterMetadata body → 200default
POST
/ng-reports/metrics/metadata/devices
Devices filter metadata
getDiagnosticsDeviceFilterMetadata body → 200default
GET
/ng-reports/metrics/get-metrics-grouping
Grouping of Metrics
metricsGrouping → 200default
POST
/ng-reports/download/reports
Download NG reports
ngReportDownload body → 202default
GET
/ng-reports/download/reports/{id}
Download the file
ngReportExport 1 param → 200default
GET
/ng-reports/information/{metrics}
Information of filters
ngReportInfo 1 param → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are XiqError (6 properties), XiqPage (4 properties), XiqErrorParams (2 properties), XiqQoeDiagnosticsData (2 properties). Each schema is shown below with its type and property counts.

XiqUniqueWifiClientsRequest-2
XiqMaxConcurrentClientsResponse
XiqQoeDiagnosticsTimeRange
object
2 properties 2 required
XiqAppTrafficPercentageRequest
XiqClientAirtimeUsageResponse
XiqMaxConcurrentClientsRequest-2
XiqQoeDiagnosticsData
object
2 properties 2 required
XiqErrorParams
object
Error parameters
2 properties
XiqAppTrafficPercentageResponse
XiqClientSessionsRequest-2
XiqDownloadReportsRequest
XiqAppTrafficPercentageRequest-2
XiqUniqueWifiClientsRequest
XiqDiagnosticsPieChart
XiqError
object
6 properties 3 required
XiqUniqueClientsByOSRequest
XiqPage
object
4 properties 4 required
XiqQoeDiagnosticsResponse
XiqUniqueClientsByOSResponse
XiqClientSessionsResponse
XiqClientAirtimeUsageRequest
XiqMaxConcurrentClientsRequest
XiqDiagnosticsTableDataResponse
object
Metrics response
1 property
XiqUniqueClientsByOSRequest-2
XiqClientAirtimeUsageRequest-2
XiqDiagnosticsTimeSeriesResponse
object
Metrics response
1 property
XiqReportMetrics
string
Metrics Type.
XiqUniqueWifiClientsResponse
XiqClientSessionsRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-ng-reports-api-openapi.yml Raw ↑

Other APIs Extreme Networks publishes across the network.

ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Alert API
Extreme Networks Application API