Generate TelemetryStatistic Report.
Since Product Version: 3.10
-
Jump To
- AAA/TACACS+ Servers Operations Service (4)
- AP Onboarding Profile Management Service (4)
- API Health Service (6)
- Access Point Operations (5)
- Alarms Management Service (5)
- Application Visibility and Control Service (1)
- CLI Template Configuration (12)
- Clients (7)
- Configuration Archive Service (7)
- Credential Profile Management Service (5)
- Credentials Service (1)
- Device Details (10)
- Device Operations (9)
- Group Management Service (8)
- Group Summary Service (8)
- Guest User Management Service (8)
- Job Operations (6)
- MAC Filters Management Service (5)
- Manage and Monitor Info Service (5)
- Managed Servers Operations (6)
- Plug and Play (11)
- Rate Limits Management Service (2)
- Report Generation Operations (1)
- Report Service (4)
- Site Map Service (3)
- Software Updates (2)
- Statistics (91)
- System Settings (26)
- Trap Receivers (4)
- User Defined Field Management (3)
- User Management Service (5)
- VNF Provisioning (16)
- Virtual Domains Management Service (10)
- Virtual Image Repository (8)
- WLAN Provisioning (16)
- Wireless Device Details (22)
- v1
- v2
- v3
- v4
This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
This resource was introduced in API version 4.
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
POST |
Resource URL
/webacs/api/v4/op/generateReport/telemetryStatisticRequest Payload Parameters
Attribute | Description | |||||||
---|---|---|---|---|---|---|---|---|
deviceHostName String[] |
Device host name for searching. By default all devices are searched. |
|||||||
endTime Long |
Required Represents the end time of a time period in milliseconds. Note: please use GMT+0 when converting time to timestamp. |
|||||||
eventType TelemetryEventType |
Event type.
|
|||||||
range Integer |
Required Specifies the range of time (in hours). This field can contain values like 1,2,4,8,16,24,168(1week),336(2Week),720(1Month),8760(1Year). Note: Either the range parameter or the parameters startTime and endTime are required. The range parameter overrides the startTime and endTime parameters. |
|||||||
rowsNumber int |
Required Count of rows to return. |
|||||||
selectedColumns TelemetryStatisticColumnEnum[] |
Selected columns. By default all report's columns are selected.
|
|||||||
Columns for ordering. By default rows are ordered in descending order of eventTime column. Note: to get the response payload sorted in the selected order, selectedColumns should be specified in the request. |
||||||||
|
||||||||
startTime Long |
Required Represents the start time of a time period in milliseconds. Note: please use GMT+0 when converting time to timestamp. |
Response Parameters
Attribute | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
rowCount int |
Count of TelemetryStatistic rows returned. |
|||||||||
TelemetryStatistic rows. |
||||||||||
|
||||||||||
totalCount int |
Total count of TelemetryStatistic rows available. |
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic
<?xml version="1.0" ?>
<telemetryReportPreferencesDTO>
<devicesHostNames>
<deviceHostName>String value</deviceHostName>
<deviceHostName>Another string value</deviceHostName>
</devicesHostNames>
<endTime>15</endTime>
<eventType>All</eventType>
<range>15</range>
<rowsNumber>1</rowsNumber>
<selectedColumns>
<selectedColumn>deviceName</selectedColumn>
<selectedColumn>eventCount</selectedColumn>
</selectedColumns>
<sortColumns>
<sortColumn>
<columnName>deviceName</columnName>
<sortDirection>ASC</sortDirection>
</sortColumn>
<sortColumn>
<columnName>eventCount</columnName>
<sortDirection>DESC</sortDirection>
</sortColumn>
</sortColumns>
<startTime>15</startTime>
</telemetryReportPreferencesDTO>
Sample JSON Request Payload
https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic.json
{
"telemetryReportPreferencesDTO" : {
"devicesHostNames" : {
"deviceHostName" : [ "String value", "Another string value" ]
},
"endTime" : 15,
"eventType" : "All",
"range" : 15,
"rowsNumber" : 1,
"selectedColumns" : {
"selectedColumn" : [ "deviceName", "eventCount" ]
},
"sortColumns" : {
"sortColumn" : [ {
"columnName" : "deviceName",
"sortDirection" : "ASC"
}, {
"columnName" : "eventCount",
"sortDirection" : "DESC"
} ]
},
"startTime" : 15
}
}
Sample XML Response Payload
https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic" rootUrl="https://localhost/webacs/api/v4/op">
<telemetryStatisticDTO>
<rowCount>1</rowCount>
<telemetryStatisticRows>
<telemetryStatisticRows>
<deviceName>String value</deviceName>
<eventCount>String value</eventCount>
<eventTime>String value</eventTime>
</telemetryStatisticRows>
<telemetryStatisticRows>
<deviceName>Another string value</deviceName>
<eventCount>Another string value</eventCount>
<eventTime>Another string value</eventTime>
</telemetryStatisticRows>
</telemetryStatisticRows>
<totalCount>1</totalCount>
</telemetryStatisticDTO>
</mgmtResponse>
Sample JSON Response Payload
https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic.json
{
"mgmtResponse" : {
"@requestUrl" : "https://localhost/webacs/api/v4/op/generateReport/telemetryStatistic",
"@responseType" : "operation",
"@rootUrl" : "https://localhost/webacs/api/v4/op",
"telemetryStatisticDTO" : [ {
"rowCount" : 1,
"telemetryStatisticRows" : {
"telemetryStatisticRows" : [ {
"deviceName" : "String value",
"eventCount" : "String value",
"eventTime" : "String value"
}, {
"deviceName" : "Another string value",
"eventCount" : "Another string value",
"eventTime" : "Another string value"
} ]
},
"totalCount" : 1
} ]
}
}