Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

POST generateReport/telemetryStatistic

Generate TelemetryStatistic Report.

Since Product Version: 3.10

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/telemetryStatistic

Request 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.

  • All
  • Client
  • Rogue AP
  • Access Point

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.

  • deviceName
  • eventCount
  • eventTime

sortColumn Arrow image SortColumnDTO[]

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.

telemetryStatisticRows Arrow image TelemetryStatisticRowDTO[]

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
    } ]
  }
}