Coveo Usage Analytics Write API — Analytics API - Version 14

naftiko: 1.0.0-alpha2
info:
  label: Coveo Usage Analytics Write API — Analytics API - Version 14
  description: 'Coveo Usage Analytics Write API — Analytics API - Version 14. 8 operations. Lead operation: Adds a Click Event
    via POST. Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Usage Analytics Write
  - Analytics API - Version 14
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_SEARCH_TOKEN: COVEO_SEARCH_TOKEN
capability:
  consumes:
  - type: http
    namespace: usage-analytics-write-analytics-api-version-14
    baseUri: https://analytics.cloud.coveo.com/rest/ua
    description: Coveo Usage Analytics Write API — Analytics API - Version 14 business capability. Self-contained, no shared
      references.
    authentication:
      type: bearer
      token: '{{env.COVEO_SEARCH_TOKEN}}'
    resources:
    - name: v14-analytics-click
      path: /v14/analytics/click
      operations:
      - name: postv14analyticsclick
        method: POST
        description: Adds a Click Event via POST
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: visitor
          in: cookie
          type: string
          description: The unique identifier of the visitor. If not provided, a new identifier will be created and returned
            as a HTTP cookie.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-analytics-custom
      path: /v14/analytics/custom
      operations:
      - name: postv14analyticscustom
        method: POST
        description: Adds a Custom Event via POST
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: visitor
          in: cookie
          type: string
          description: The unique identifier of the visitor. If not provided, a new identifier will be created and returned
            as a HTTP cookie.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-analytics-monitoring-health
      path: /v14/analytics/monitoring/health
      operations:
      - name: getv14analyticsmonitoringhealth
        method: GET
        description: Health Check for the Analytics Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v14-analytics-search
      path: /v14/analytics/search
      operations:
      - name: postv14analyticssearch
        method: POST
        description: Adds a Search Event via POST
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: visitor
          in: cookie
          type: string
          description: The unique identifier of the visitor. If not provided, a new identifier will be created and returned
            as a HTTP cookie.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-analytics-searches
      path: /v14/analytics/searches
      operations:
      - name: postv14analyticssearches
        method: POST
        description: Adds Multiple Search Events via POST
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: visitor
          in: cookie
          type: string
          description: The unique identifier of the visitor. If not provided, a new identifier will be created and returned
            as a HTTP cookie.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v14-analytics-status
      path: /v14/analytics/status
      operations:
      - name: getv14analyticsstatus
        method: GET
        description: Gets the Status of the Analytics Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v14-analytics-visit
      path: /v14/analytics/visit
      operations:
      - name: getv14analyticsvisit
        method: GET
        description: Get the User Current Visit Informations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: user
          in: query
          type: string
          description: The unique identifier of the user performing the search event. If not provided, the username will be
            extracted from the token.
        - name: visitor
          in: cookie
          type: string
          description: The unique identifier of the visitor. If not provided, a new identifier will be created and returned
            as a HTTP cookie.
      - name: deletev14analyticsvisit
        method: DELETE
        description: Clears All Cookies Associated with This API
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: usage-analytics-write-analytics-api-version-14-rest
    port: 8080
    description: REST adapter for Coveo Usage Analytics Write API — Analytics API - Version 14. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/v14/analytics/click
      name: v14-analytics-click
      description: REST surface for v14-analytics-click.
      operations:
      - method: POST
        name: postv14analyticsclick
        description: Adds a Click Event via POST
        call: usage-analytics-write-analytics-api-version-14.postv14analyticsclick
        with:
          visitor: rest.visitor
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/custom
      name: v14-analytics-custom
      description: REST surface for v14-analytics-custom.
      operations:
      - method: POST
        name: postv14analyticscustom
        description: Adds a Custom Event via POST
        call: usage-analytics-write-analytics-api-version-14.postv14analyticscustom
        with:
          visitor: rest.visitor
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/monitoring/health
      name: v14-analytics-monitoring-health
      description: REST surface for v14-analytics-monitoring-health.
      operations:
      - method: GET
        name: getv14analyticsmonitoringhealth
        description: Health Check for the Analytics Service
        call: usage-analytics-write-analytics-api-version-14.getv14analyticsmonitoringhealth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/search
      name: v14-analytics-search
      description: REST surface for v14-analytics-search.
      operations:
      - method: POST
        name: postv14analyticssearch
        description: Adds a Search Event via POST
        call: usage-analytics-write-analytics-api-version-14.postv14analyticssearch
        with:
          visitor: rest.visitor
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/searches
      name: v14-analytics-searches
      description: REST surface for v14-analytics-searches.
      operations:
      - method: POST
        name: postv14analyticssearches
        description: Adds Multiple Search Events via POST
        call: usage-analytics-write-analytics-api-version-14.postv14analyticssearches
        with:
          visitor: rest.visitor
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/status
      name: v14-analytics-status
      description: REST surface for v14-analytics-status.
      operations:
      - method: GET
        name: getv14analyticsstatus
        description: Gets the Status of the Analytics Service
        call: usage-analytics-write-analytics-api-version-14.getv14analyticsstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v14/analytics/visit
      name: v14-analytics-visit
      description: REST surface for v14-analytics-visit.
      operations:
      - method: GET
        name: getv14analyticsvisit
        description: Get the User Current Visit Informations
        call: usage-analytics-write-analytics-api-version-14.getv14analyticsvisit
        with:
          user: rest.user
          visitor: rest.visitor
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletev14analyticsvisit
        description: Clears All Cookies Associated with This API
        call: usage-analytics-write-analytics-api-version-14.deletev14analyticsvisit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: usage-analytics-write-analytics-api-version-14-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Usage Analytics Write API — Analytics API - Version 14. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: adds-click-event-post
      description: Adds a Click Event via POST
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-write-analytics-api-version-14.postv14analyticsclick
      with:
        visitor: tools.visitor
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: adds-custom-event-post
      description: Adds a Custom Event via POST
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: usage-analytics-write-analytics-api-version-14.postv14analyticscustom
      with:
        visitor: tools.visitor
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: health-check-analytics-service
      description: Health Check for the Analytics Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-write-analytics-api-version-14.getv14analyticsmonitoringhealth
      outputParameters:
      - type: object
        mapping: $.
    - name: adds-search-event-post
      description: Adds a Search Event via POST
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: usage-analytics-write-analytics-api-version-14.postv14analyticssearch
      with:
        visitor: tools.visitor
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: adds-multiple-search-events-post
      description: Adds Multiple Search Events via POST
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: usage-analytics-write-analytics-api-version-14.postv14analyticssearches
      with:
        visitor: tools.visitor
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: gets-status-analytics-service
      description: Gets the Status of the Analytics Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-write-analytics-api-version-14.getv14analyticsstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-current-visit-informations
      description: Get the User Current Visit Informations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: usage-analytics-write-analytics-api-version-14.getv14analyticsvisit
      with:
        user: tools.user
        visitor: tools.visitor
      outputParameters:
      - type: object
        mapping: $.
    - name: clears-all-cookies-associated-this
      description: Clears All Cookies Associated with This API
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: usage-analytics-write-analytics-api-version-14.deletev14analyticsvisit
      outputParameters:
      - type: object
        mapping: $.