Whatfix API — Analytics

naftiko: 1.0.0-alpha2
info:
  label: Whatfix API — Analytics
  description: 'Whatfix API — Analytics. 4 operations. Lead operation: Get End User Engagement. Self-contained Naftiko capability
    covering one Whatfix business surface.'
  tags:
  - Whatfix
  - Analytics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WHATFIX_API_KEY: WHATFIX_API_KEY
capability:
  consumes:
  - type: http
    namespace: whatfix-analytics
    baseUri: https://whatfix.com/api/v1
    description: Whatfix API — Analytics business capability. Self-contained, no shared references.
    resources:
    - name: accountId-analytics-end-users
      path: /{accountId}/analytics/end-users
      operations:
      - name: getenduserengagement
        method: GET
        description: Get End User Engagement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-analytics-flows
      path: /{accountId}/analytics/flows
      operations:
      - name: getflowanalytics
        method: GET
        description: Get Flow Analytics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-analytics-self-help
      path: /{accountId}/analytics/self-help
      operations:
      - name: getselfhelpanalytics
        method: GET
        description: Get Self Help Analytics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: accountId-analytics-task-completion
      path: /{accountId}/analytics/task-completion
      operations:
      - name: getusertaskcompletion
        method: GET
        description: Get User Task Completion
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: x-whatfix-integration-key
      value: '{{env.WHATFIX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: whatfix-analytics-rest
    port: 8080
    description: REST adapter for Whatfix API — Analytics. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/{accountid}/analytics/end-users
      name: accountid-analytics-end-users
      description: REST surface for accountId-analytics-end-users.
      operations:
      - method: GET
        name: getenduserengagement
        description: Get End User Engagement
        call: whatfix-analytics.getenduserengagement
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{accountid}/analytics/flows
      name: accountid-analytics-flows
      description: REST surface for accountId-analytics-flows.
      operations:
      - method: GET
        name: getflowanalytics
        description: Get Flow Analytics
        call: whatfix-analytics.getflowanalytics
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{accountid}/analytics/self-help
      name: accountid-analytics-self-help
      description: REST surface for accountId-analytics-self-help.
      operations:
      - method: GET
        name: getselfhelpanalytics
        description: Get Self Help Analytics
        call: whatfix-analytics.getselfhelpanalytics
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{accountid}/analytics/task-completion
      name: accountid-analytics-task-completion
      description: REST surface for accountId-analytics-task-completion.
      operations:
      - method: GET
        name: getusertaskcompletion
        description: Get User Task Completion
        call: whatfix-analytics.getusertaskcompletion
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: whatfix-analytics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Whatfix API — Analytics. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-end-user-engagement
      description: Get End User Engagement
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: whatfix-analytics.getenduserengagement
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-analytics
      description: Get Flow Analytics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: whatfix-analytics.getflowanalytics
      outputParameters:
      - type: object
        mapping: $.
    - name: get-self-help-analytics
      description: Get Self Help Analytics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: whatfix-analytics.getselfhelpanalytics
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-task-completion
      description: Get User Task Completion
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: whatfix-analytics.getusertaskcompletion
      outputParameters:
      - type: object
        mapping: $.