Cisco Voice Portal Reporting API — Historical Reports

naftiko: 1.0.0-alpha2
info:
  label: Cisco Voice Portal Reporting API — Historical Reports
  description: 'Cisco Voice Portal Reporting API — Historical Reports. 3 operations. Lead operation: Cisco Voice Portal Get
    Vxml Application Statistics. Self-contained Naftiko capability covering one Cisco Voice Portal business surface.'
  tags:
  - Cisco Voice Portal
  - Historical Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CISCO_VOICE_PORTAL_API_KEY: CISCO_VOICE_PORTAL_API_KEY
capability:
  consumes:
  - type: http
    namespace: reporting-historical-reports
    baseUri: https://{reporting-server}:8111/cvp-reporting/rest
    description: Cisco Voice Portal Reporting API — Historical Reports business capability. Self-contained, no shared references.
    resources:
    - name: statistics-application
      path: /statistics/application
      operations:
      - name: getapplicationstatistics
        method: GET
        description: Cisco Voice Portal Get Vxml Application Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startTime
          in: query
          type: string
          required: true
        - name: endTime
          in: query
          type: string
          required: true
        - name: applicationName
          in: query
          type: string
          description: Filter by specific application name
    - name: statistics-server
      path: /statistics/server
      operations:
      - name: getserverstatistics
        method: GET
        description: Cisco Voice Portal Get Per-server Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startTime
          in: query
          type: string
          required: true
        - name: endTime
          in: query
          type: string
          required: true
        - name: serverType
          in: query
          type: string
          description: Filter by server type
    - name: statistics-summary
      path: /statistics/summary
      operations:
      - name: getcallsummarystatistics
        method: GET
        description: Cisco Voice Portal Get Call Summary Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startTime
          in: query
          type: string
          required: true
        - name: endTime
          in: query
          type: string
          required: true
        - name: interval
          in: query
          type: string
          description: Aggregation interval
        - name: calledNumber
          in: query
          type: string
          description: Filter by called number (DNIS)
    authentication:
      type: basic
      username: '{{env.CISCO_VOICE_PORTAL_USER}}'
      password: '{{env.CISCO_VOICE_PORTAL_PASS}}'
  exposes:
  - type: rest
    namespace: reporting-historical-reports-rest
    port: 8080
    description: REST adapter for Cisco Voice Portal Reporting API — Historical Reports. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/statistics/application
      name: statistics-application
      description: REST surface for statistics-application.
      operations:
      - method: GET
        name: getapplicationstatistics
        description: Cisco Voice Portal Get Vxml Application Statistics
        call: reporting-historical-reports.getapplicationstatistics
        with:
          startTime: rest.startTime
          endTime: rest.endTime
          applicationName: rest.applicationName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/statistics/server
      name: statistics-server
      description: REST surface for statistics-server.
      operations:
      - method: GET
        name: getserverstatistics
        description: Cisco Voice Portal Get Per-server Statistics
        call: reporting-historical-reports.getserverstatistics
        with:
          startTime: rest.startTime
          endTime: rest.endTime
          serverType: rest.serverType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/statistics/summary
      name: statistics-summary
      description: REST surface for statistics-summary.
      operations:
      - method: GET
        name: getcallsummarystatistics
        description: Cisco Voice Portal Get Call Summary Statistics
        call: reporting-historical-reports.getcallsummarystatistics
        with:
          startTime: rest.startTime
          endTime: rest.endTime
          interval: rest.interval
          calledNumber: rest.calledNumber
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: reporting-historical-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for Cisco Voice Portal Reporting API — Historical Reports. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: cisco-voice-portal-get-vxml
      description: Cisco Voice Portal Get Vxml Application Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reporting-historical-reports.getapplicationstatistics
      with:
        startTime: tools.startTime
        endTime: tools.endTime
        applicationName: tools.applicationName
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-per
      description: Cisco Voice Portal Get Per-server Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reporting-historical-reports.getserverstatistics
      with:
        startTime: tools.startTime
        endTime: tools.endTime
        serverType: tools.serverType
      outputParameters:
      - type: object
        mapping: $.
    - name: cisco-voice-portal-get-call
      description: Cisco Voice Portal Get Call Summary Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: reporting-historical-reports.getcallsummarystatistics
      with:
        startTime: tools.startTime
        endTime: tools.endTime
        interval: tools.interval
        calledNumber: tools.calledNumber
      outputParameters:
      - type: object
        mapping: $.