Coveo Event API — Usage Analytics Event Validation API

naftiko: 1.0.0-alpha2
info:
  label: Coveo Event API — Usage Analytics Event Validation API
  description: 'Coveo Event API — Usage Analytics Event Validation API. 6 operations. Lead operation: Validate Click Event.
    Self-contained Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Event
  - Usage Analytics Event Validation API
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: event-usage-analytics-event-validation-api
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Event API — Usage Analytics Event Validation API business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-events-v1-analytics-click-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/click/validate
      operations:
      - name: validateclickevent
        method: POST
        description: Validate Click Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-analytics-collect-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/collect/validate
      operations:
      - name: validatecollectevent
        method: POST
        description: Validate Collect Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-analytics-custom-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/custom/validate
      operations:
      - name: validatecustomevent
        method: POST
        description: Validate Custom Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-analytics-search-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/search/validate
      operations:
      - name: validatesearchevent
        method: POST
        description: Validate Search Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-analytics-searches-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/searches/validate
      operations:
      - name: validatesearchesevent
        method: POST
        description: Validate Search Events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-events-v1-analytics-view-validate
      path: /rest/organizations/{organizationId}/events/v1/analytics/view/validate
      operations:
      - name: validateviewevent
        method: POST
        description: Validate View Event
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: event-usage-analytics-event-validation-api-rest
    port: 8080
    description: REST adapter for Coveo Event API — Usage Analytics Event Validation API. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/events/v1/analytics/click/validate
      name: rest-organizations-organizationid-events-v1-analytics-click-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-click-validate.
      operations:
      - method: POST
        name: validateclickevent
        description: Validate Click Event
        call: event-usage-analytics-event-validation-api.validateclickevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/analytics/collect/validate
      name: rest-organizations-organizationid-events-v1-analytics-collect-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-collect-validate.
      operations:
      - method: POST
        name: validatecollectevent
        description: Validate Collect Event
        call: event-usage-analytics-event-validation-api.validatecollectevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/analytics/custom/validate
      name: rest-organizations-organizationid-events-v1-analytics-custom-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-custom-validate.
      operations:
      - method: POST
        name: validatecustomevent
        description: Validate Custom Event
        call: event-usage-analytics-event-validation-api.validatecustomevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/analytics/search/validate
      name: rest-organizations-organizationid-events-v1-analytics-search-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-search-validate.
      operations:
      - method: POST
        name: validatesearchevent
        description: Validate Search Event
        call: event-usage-analytics-event-validation-api.validatesearchevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/analytics/searches/validate
      name: rest-organizations-organizationid-events-v1-analytics-searches-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-searches-validate.
      operations:
      - method: POST
        name: validatesearchesevent
        description: Validate Search Events
        call: event-usage-analytics-event-validation-api.validatesearchesevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/events/v1/analytics/view/validate
      name: rest-organizations-organizationid-events-v1-analytics-view-validate
      description: REST surface for rest-organizations-organizationId-events-v1-analytics-view-validate.
      operations:
      - method: POST
        name: validateviewevent
        description: Validate View Event
        call: event-usage-analytics-event-validation-api.validateviewevent
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: event-usage-analytics-event-validation-api-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Event API — Usage Analytics Event Validation API. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: validate-click-event
      description: Validate Click Event
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validateclickevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-collect-event
      description: Validate Collect Event
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validatecollectevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-custom-event
      description: Validate Custom Event
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validatecustomevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-search-event
      description: Validate Search Event
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validatesearchevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-search-events
      description: Validate Search Events
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validatesearchesevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-view-event
      description: Validate View Event
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: event-usage-analytics-event-validation-api.validateviewevent
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.