Cisco Voice Portal Report Templates API

Execute pre-defined report templates

Operations 3

GET /report Cisco Voice Portal List Available Report Templates #
POST /report/{templateId}/execute Cisco Voice Portal Execute a Report Template #
GET /report/{reportId}/result Cisco Voice Portal Get Report Execution Result #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cisco-voice-portal-report-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cisco-voice-portal-report-templates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cisco Voice Portal Reporting Report Templates API
  description: The Cisco Unified Customer Voice Portal (CVP) Reporting API provides access to call detail records (CDRs), real-time call statistics, and historical reporting data. The Reporting Server collects data from CVP Call Servers and VXML Servers, storing it in the CVP Reporting Database (an Informix database). This API provides RESTful access to reporting data that is typically accessed via the Cisco Unified Intelligence Center (CUIC) reporting interface.
  version: 12.6.0
  contact:
    name: Cisco Developer Support
    url: https://developer.cisco.com/
  license:
    name: Cisco DevNet
    url: https://developer.cisco.com/site/license/
  x-provider: cisco
  x-product: unified-customer-voice-portal
servers:
- url: https://{reporting-server}:8111/cvp-reporting/rest
  description: CVP Reporting Server REST API
  variables:
    reporting-server:
      default: cvp-reporting.example.com
      description: Hostname or IP of the CVP Reporting Server
security:
- basicAuth: []
tags:
- name: Report Templates
  description: Execute pre-defined report templates
paths:
  /report:
    get:
      operationId: listReportTemplates
      summary: Cisco Voice Portal List Available Report Templates
      description: Retrieves a list of available report templates that can be executed. These correspond to the standard CVP reports available in Cisco Unified Intelligence Center.
      tags:
      - Report Templates
      responses:
        '200':
          description: List of report templates
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportTemplate'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /report/{templateId}/execute:
    post:
      operationId: executeReport
      summary: Cisco Voice Portal Execute a Report Template
      description: Executes a report template with the specified parameters. Reports may be generated synchronously for small datasets or asynchronously for large reports.
      tags:
      - Report Templates
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReportExecutionRequest'
      responses:
        '200':
          description: Report results (synchronous)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResult'
        '202':
          description: Report generation initiated (asynchronous)
          content:
            application/json:
              schema:
                type: object
                properties:
                  reportId:
                    type: string
                  status:
                    type: string
                    enum:
                    - processing
                  estimatedCompletionTime:
                    type: string
                    format: date-time
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /report/{reportId}/result:
    get:
      operationId: getReportResult
      summary: Cisco Voice Portal Get Report Execution Result
      description: Retrieves the result of a previously executed report. For asynchronous reports, returns the result once generation is complete.
      tags:
      - Report Templates
      parameters:
      - name: reportId
        in: path
        required: true
        schema:
          type: string
      - name: format
        in: query
        description: Output format
        schema:
          type: string
          enum:
          - json
          - csv
          default: json
      responses:
        '200':
          description: Report result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportResult'
            text/csv:
              schema:
                type: string
        '202':
          description: Report still processing
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ReportExecutionRequest:
      type: object
      properties:
        parameters:
          type: object
          additionalProperties: true
          description: Report parameters as defined by the template
          example: example_value
        format:
          type: string
          enum:
          - json
          - csv
          default: json
          example: json
        async:
          type: boolean
          default: false
          description: Whether to execute asynchronously
          example: true
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        details:
          type: string
          example: example_value
        timestamp:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    ReportResult:
      type: object
      properties:
        reportId:
          type: string
          example: '500123'
        templateId:
          type: string
          example: '500123'
        templateName:
          type: string
          example: example_value
        status:
          type: string
          enum:
          - completed
          - processing
          - error
          example: completed
        generatedAt:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        parameters:
          type: object
          additionalProperties: true
          example: example_value
        columns:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
          example: []
        rows:
          type: array
          items:
            type: array
            items: {}
          example: []
        totalRows:
          type: integer
          example: 10
    ReportTemplate:
      type: object
      properties:
        templateId:
          type: string
          example: '500123'
        name:
          type: string
          example: Example Title
        description:
          type: string
          example: A sample description.
        category:
          type: string
          enum:
          - call_activity
          - application_performance
          - server_performance
          - error_analysis
          example: call_activity
        parameters:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              required:
                type: boolean
              description:
                type: string
          example: []
  responses:
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CVP reporting credentials