Hotjar REST API — Surveys

naftiko: 1.0.0-alpha2
info:
  label: Hotjar REST API — Surveys
  description: 'Hotjar REST API — Surveys. 2 operations. Lead operation: List surveys for a site. Self-contained Naftiko capability
    covering one Hotjar business surface.'
  tags:
  - Hotjar
  - Surveys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HOTJAR_API_KEY: HOTJAR_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-surveys
    baseUri: https://api.hotjar.io/v1
    description: Hotjar REST API — Surveys business capability. Self-contained, no shared references.
    resources:
    - name: sites-site_id-surveys
      path: /sites/{site_id}/surveys
      operations:
      - name: listsurveys
        method: GET
        description: List surveys for a site
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sites-site_id-surveys-survey_id
      path: /sites/{site_id}/surveys/{survey_id}
      operations:
      - name: getsurvey
        method: GET
        description: Get a specific survey
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.HOTJAR_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-surveys-rest
    port: 8080
    description: REST adapter for Hotjar REST API — Surveys. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/sites/{site-id}/surveys
      name: sites-site-id-surveys
      description: REST surface for sites-site_id-surveys.
      operations:
      - method: GET
        name: listsurveys
        description: List surveys for a site
        call: rest-surveys.listsurveys
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sites/{site-id}/surveys/{survey-id}
      name: sites-site-id-surveys-survey-id
      description: REST surface for sites-site_id-surveys-survey_id.
      operations:
      - method: GET
        name: getsurvey
        description: Get a specific survey
        call: rest-surveys.getsurvey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-surveys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Hotjar REST API — Surveys. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-surveys-site
      description: List surveys for a site
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-surveys.listsurveys
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-survey
      description: Get a specific survey
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-surveys.getsurvey
      outputParameters:
      - type: object
        mapping: $.