Coveo Usage Analytics Read API — Filters API - Version 14

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — Filters API - Version 14
  description: 'Coveo Usage Analytics Read API — Filters API - Version 14. 14 operations. Lead operation: Health Check for
    the Filter Service. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - Filters API - Version 14
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: usage-analytics-read-filters-api-version-14
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — Filters API - Version 14 business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v14-filters-monitoring-health
      path: /v14/filters/monitoring/health
      operations:
      - name: getv14filtersmonitoringhealth
        method: GET
        description: Health Check for the Filter Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v14-filters-permissions
      path: /v14/filters/permissions
      operations:
      - name: getv14filterspermissions
        method: GET
        description: Get All the Permission Filters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: postv14filterspermissions
        method: POST
        description: Create a Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-filters-permissions-filterId
      path: /v14/filters/permissions/{filterId}
      operations:
      - name: getv14filterspermissionsfilterid
        method: GET
        description: Get a Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: putv14filterspermissionsfilterid
        method: PUT
        description: Update a Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletev14filterspermissionsfilterid
        method: DELETE
        description: Deletes the Specified Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-filters-permissions-filterId-users
      path: /v14/filters/permissions/{filterId}/users
      operations:
      - name: getv14filterspermissionsfilteridusers
        method: GET
        description: Get the Users of a Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: putv14filterspermissionsfilteridusers
        method: PUT
        description: Set the Users of a Permission Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-filters-reporting
      path: /v14/filters/reporting
      operations:
      - name: getv14filtersreporting
        method: GET
        description: Get All the Reporting Filters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: postv14filtersreporting
        method: POST
        description: Create a Reporting Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-filters-reporting-filterId
      path: /v14/filters/reporting/{filterId}
      operations:
      - name: getv14filtersreportingfilterid
        method: GET
        description: Gets the Specified Reporting Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
      - name: putv14filtersreportingfilterid
        method: PUT
        description: Update a Reporting Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletev14filtersreportingfilterid
        method: DELETE
        description: Deletes the Specified Reporting Filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filterId
          in: path
          type: string
          description: The unique identifier of a filter. This id is generated by the server when creating a filter.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v14-filters-status
      path: /v14/filters/status
      operations:
      - name: getv14filtersstatus
        method: GET
        description: Gets the Status of the Filter Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: usage-analytics-read-filters-api-version-14-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — Filters API - Version 14. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v14/filters/monitoring/health
      name: v14-filters-monitoring-health
      description: REST surface for v14-filters-monitoring-health.
      operations:
      - method: GET
        name: getv14filtersmonitoringhealth
        description: Health Check for the Filter Service
        call: usage-analytics-read-filters-api-version-14.getv14filtersmonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/permissions
      name: v14-filters-permissions
      description: REST surface for v14-filters-permissions.
      operations:
      - method: GET
        name: getv14filterspermissions
        description: Get All the Permission Filters
        call: usage-analytics-read-filters-api-version-14.getv14filterspermissions
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv14filterspermissions
        description: Create a Permission Filter
        call: usage-analytics-read-filters-api-version-14.postv14filterspermissions
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/permissions/{filterid}
      name: v14-filters-permissions-filterid
      description: REST surface for v14-filters-permissions-filterId.
      operations:
      - method: GET
        name: getv14filterspermissionsfilterid
        description: Get a Permission Filter
        call: usage-analytics-read-filters-api-version-14.getv14filterspermissionsfilterid
        with:
          filterId: rest.filterId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv14filterspermissionsfilterid
        description: Update a Permission Filter
        call: usage-analytics-read-filters-api-version-14.putv14filterspermissionsfilterid
        with:
          filterId: rest.filterId
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev14filterspermissionsfilterid
        description: Deletes the Specified Permission Filter
        call: usage-analytics-read-filters-api-version-14.deletev14filterspermissionsfilterid
        with:
          filterId: rest.filterId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/permissions/{filterid}/users
      name: v14-filters-permissions-filterid-users
      description: REST surface for v14-filters-permissions-filterId-users.
      operations:
      - method: GET
        name: getv14filterspermissionsfilteridusers
        description: Get the Users of a Permission Filter
        call: usage-analytics-read-filters-api-version-14.getv14filterspermissionsfilteridusers
        with:
          filterId: rest.filterId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv14filterspermissionsfilteridusers
        description: Set the Users of a Permission Filter
        call: usage-analytics-read-filters-api-version-14.putv14filterspermissionsfilteridusers
        with:
          filterId: rest.filterId
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/reporting
      name: v14-filters-reporting
      description: REST surface for v14-filters-reporting.
      operations:
      - method: GET
        name: getv14filtersreporting
        description: Get All the Reporting Filters
        call: usage-analytics-read-filters-api-version-14.getv14filtersreporting
        with:
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postv14filtersreporting
        description: Create a Reporting Filter
        call: usage-analytics-read-filters-api-version-14.postv14filtersreporting
        with:
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/reporting/{filterid}
      name: v14-filters-reporting-filterid
      description: REST surface for v14-filters-reporting-filterId.
      operations:
      - method: GET
        name: getv14filtersreportingfilterid
        description: Gets the Specified Reporting Filter
        call: usage-analytics-read-filters-api-version-14.getv14filtersreportingfilterid
        with:
          filterId: rest.filterId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putv14filtersreportingfilterid
        description: Update a Reporting Filter
        call: usage-analytics-read-filters-api-version-14.putv14filtersreportingfilterid
        with:
          filterId: rest.filterId
          org: rest.org
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev14filtersreportingfilterid
        description: Deletes the Specified Reporting Filter
        call: usage-analytics-read-filters-api-version-14.deletev14filtersreportingfilterid
        with:
          filterId: rest.filterId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/filters/status
      name: v14-filters-status
      description: REST surface for v14-filters-status.
      operations:
      - method: GET
        name: getv14filtersstatus
        description: Gets the Status of the Filter Service
        call: usage-analytics-read-filters-api-version-14.getv14filtersstatus
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-filters-api-version-14-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — Filters API - Version 14. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: health-check-filter-service
      description: Health Check for the Filter Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filtersmonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-permission-filters
      description: Get All the Permission Filters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filterspermissions
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: create-permission-filter
      description: Create a Permission Filter
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-filters-api-version-14.postv14filterspermissions
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-permission-filter
      description: Get a Permission Filter
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filterspermissionsfilterid
      with:
        filterId: tools.filterId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: update-permission-filter
      description: Update a Permission Filter
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.putv14filterspermissionsfilterid
      with:
        filterId: tools.filterId
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-specified-permission-filter
      description: Deletes the Specified Permission Filter
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.deletev14filterspermissionsfilterid
      with:
        filterId: tools.filterId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-users-permission-filter
      description: Get the Users of a Permission Filter
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filterspermissionsfilteridusers
      with:
        filterId: tools.filterId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: set-users-permission-filter
      description: Set the Users of a Permission Filter
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.putv14filterspermissionsfilteridusers
      with:
        filterId: tools.filterId
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-reporting-filters
      description: Get All the Reporting Filters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filtersreporting
      with:
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: create-reporting-filter
      description: Create a Reporting Filter
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-read-filters-api-version-14.postv14filtersreporting
      with:
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-specified-reporting-filter
      description: Gets the Specified Reporting Filter
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filtersreportingfilterid
      with:
        filterId: tools.filterId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: update-reporting-filter
      description: Update a Reporting Filter
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.putv14filtersreportingfilterid
      with:
        filterId: tools.filterId
        org: tools.org
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-specified-reporting-filter
      description: Deletes the Specified Reporting Filter
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.deletev14filtersreportingfilterid
      with:
        filterId: tools.filterId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-status-filter-service
      description: Gets the Status of the Filter Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-filters-api-version-14.getv14filtersstatus
      outputParameters:
      - type: object
        mapping: $.