Coveo Usage Analytics Read API — User Statistics API - Version 15

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Read API — User Statistics API - Version 15
  description: 'Coveo Usage Analytics Read API — User Statistics API - Version 15. 2 operations. Lead operation: Delete the
    User Data. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Read
  - User Statistics API - Version 15
  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-user-statistics-api-version-15
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Read API — User Statistics API - Version 15 business capability. Self-contained, no
      shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: v15-users-userId-alldata
      path: /v15/users/{userId}/alldata
      operations:
      - name: deletev15usersuseridalldata
        method: DELETE
        description: Delete the User Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The unique identifier of a user.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
    - name: v15-users-userId-overview
      path: /v15/users/{userId}/overview
      operations:
      - name: getv15usersuseridoverview
        method: GET
        description: Get the Stats of a User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: The unique identifier of a user.
          required: true
        - name: org
          in: query
          type: string
          description: The name of the organization (Coveo Cloud V2 only)
        - name: cached
          in: query
          type: string
          description: cached
  exposes:
  - type: rest
    namespace: usage-analytics-read-user-statistics-api-version-15-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Read API — User Statistics API - Version 15. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v15/users/{userid}/alldata
      name: v15-users-userid-alldata
      description: REST surface for v15-users-userId-alldata.
      operations:
      - method: DELETE
        name: deletev15usersuseridalldata
        description: Delete the User Data
        call: usage-analytics-read-user-statistics-api-version-15.deletev15usersuseridalldata
        with:
          userId: rest.userId
          org: rest.org
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v15/users/{userid}/overview
      name: v15-users-userid-overview
      description: REST surface for v15-users-userId-overview.
      operations:
      - method: GET
        name: getv15usersuseridoverview
        description: Get the Stats of a User
        call: usage-analytics-read-user-statistics-api-version-15.getv15usersuseridoverview
        with:
          userId: rest.userId
          org: rest.org
          cached: rest.cached
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-read-user-statistics-api-version-15-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Read API — User Statistics API - Version 15. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: delete-user-data
      description: Delete the User Data
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-read-user-statistics-api-version-15.deletev15usersuseridalldata
      with:
        userId: tools.userId
        org: tools.org
      outputParameters:
      - type: object
        mapping: $.
    - name: get-stats-user
      description: Get the Stats of a User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-read-user-statistics-api-version-15.getv15usersuseridoverview
      with:
        userId: tools.userId
        org: tools.org
        cached: tools.cached
      outputParameters:
      - type: object
        mapping: $.