openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Monitoring - Device Statistics Details API
  description: "Includes API operations for the following:\n  Real-time monitoring\n  Accessing statistics APIs and statistics bulk APIs\n  Retrieving device state\n  Managing alarms and events"
  contact:
    email: vmanage@cisco.com
  license:
    name: Commercial License
    url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html
  version: 26.1.0+2026-01-06
  x-provenance:
    method: harvested
    authored_by: Cisco Catalyst SD-WAN
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/
  - type: source
    url: https://developer.cisco.com/docs/sdwan/
servers:
- url: /dataservice
tags:
- name: Monitoring - Device Statistics Details
paths:
  /data/device/statistics:
    get:
      tags:
      - Monitoring - Device Statistics Details
      description: Get statistics types
      operationId: getStatisticsType
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Status:
                  description: Status
                  value:
                  - interfacestatistics
                  - eioltestatistics
                  - sulstatistics
                  - qosstatistics
                  - devicesystemstatusstatistics
                  - bridgemacstatistics
                  - dpistatistics
                  - approutestatsstatistics
                  - wlanclientinfostatistics
                  - flowlogstatistics
                  - urlf
                  - fwall
                  - vnfstatistics
                  - umbrella
                  - apphostingstatistics
                  - utddaqioxstatistics
                  - ipsalert
                  - aggregatedappsdpistatistics
                  - bridgeinterfacestatistics
                  - artstatistics
                  - trackerstatistics
                  - cloudxstatistics
                  - deviceevents
                  - sleofflinereport
                  - alarm
                  - auditlog
                  - deviceconfiguration
                  - nwpi
                  - nwpiflowraw
                  - speedtest
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /data/device/statistics/alarm/active:
    get:
      tags:
      - Monitoring - Device Statistics Details
      description: Get active alarms
      operationId: getActiveAlarms
      parameters:
      - name: scrollId
        in: query
        description: SrollId
        schema:
          type: string
      - name: startDate
        in: query
        description: Start date (example:2023-10-31T14:30:00)
        schema:
          pattern: ^\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\d{2}:\d{2}:\d{2}$
          type: string
      - name: endDate
        in: query
        description: End date (example:2023-10-31T14:30:00)
        schema:
          pattern: ^\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\d{2}:\d{2}:\d{2}$
          type: string
      - name: count
        in: query
        description: count
        schema:
          type: integer
          format: int64
      - name: timeZone
        in: query
        description: Time zone
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                Active alarms:
                  description: Active alarms
                  value: []
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Alarms-read
  /data/device/statistics/{state_data_type}:
    get:
      tags:
      - Monitoring - Device Statistics Details
      description: Get device statistics data
      operationId: generateDeviceStatisticsData
      parameters:
      - name: state_data_type
        in: path
        description: State data type
        required: true
        schema:
          type: string
      - name: scrollId
        in: query
        description: Scroll Id
        schema:
          type: string
      - name: startDate
        in: query
        description: Start date
        schema:
          type: string
      - name: endDate
        in: query
        description: End date
        schema:
          type: string
      - name: count
        in: query
        schema:
          type: integer
          format: int32
      - name: timeZone
        in: query
        description: Time zone
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                Statistics data:
                  description: Statistics data
                  value: []
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,Device Monitoring-write,dca
  /data/device/statistics/{state_data_type}/doccount:
    get:
      tags:
      - Monitoring - Device Statistics Details
      description: Get response count of a query
      operationId: getCountWithStateDataType
      parameters:
      - name: state_data_type
        in: path
        description: State data type(example:object)
        required: true
        schema:
          pattern: ^[a-zA-Z-_]+$
          type: string
      - name: startDate
        in: query
        description: Start date (example:2023-10-31T14:30:00)
        required: true
        schema:
          pattern: ^\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\d{2}:\d{2}:\d{2}$
          type: string
      - name: endDate
        in: query
        description: End date (example:2023-10-31T14:30:00)
        required: true
        schema:
          pattern: ^\d{4}-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01])T\d{2}:\d{2}:\d{2}$
          type: string
      - name: timeZone
        in: query
        description: Time zone (example:UTC)
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Response count:
                  description: Response count
                  value: {}
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /data/device/statistics/{state_data_type}/fields:
    get:
      tags:
      - Monitoring - Device Statistics Details
      description: Get statistics fields and types
      operationId: getStatDataFieldsByStateDataType
      parameters:
      - name: state_data_type
        in: path
        description: State data type
        required: true
        schema:
          pattern: ^[a-zA-Z-_]+$
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                Statistics field and type:
                  description: Statistics field and type
                  value: []
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read