Umami Analytics API — Sessions

naftiko: 1.0.0-alpha2
info:
  label: Umami Analytics API — Sessions
  description: 'Umami Analytics API — Sessions. 2 operations. Lead operation: Umami List Sessions. Self-contained Naftiko
    capability covering one Umami business surface.'
  tags:
  - Umami
  - Sessions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UMAMI_API_KEY: UMAMI_API_KEY
capability:
  consumes:
  - type: http
    namespace: umami-sessions
    baseUri: https://api.umami.is
    description: Umami Analytics API — Sessions business capability. Self-contained, no shared references.
    resources:
    - name: api-websites-websiteId-sessions
      path: /api/websites/{websiteId}/sessions
      operations:
      - name: listsessions
        method: GET
        description: Umami List Sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: websiteId
          in: path
          type: string
          description: Website identifier
          required: true
        - name: startAt
          in: query
          type: integer
          description: Start timestamp in milliseconds
          required: true
        - name: endAt
          in: query
          type: integer
          description: End timestamp in milliseconds
          required: true
        - name: page
          in: query
          type: integer
          description: Page number
        - name: pageSize
          in: query
          type: integer
          description: Results per page
    - name: api-websites-websiteId-sessions-stats
      path: /api/websites/{websiteId}/sessions/stats
      operations:
      - name: getsessionstats
        method: GET
        description: Umami Session Stats
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: websiteId
          in: path
          type: string
          description: Website identifier
          required: true
        - name: startAt
          in: query
          type: integer
          description: Start timestamp in milliseconds
          required: true
        - name: endAt
          in: query
          type: integer
          description: End timestamp in milliseconds
          required: true
    authentication:
      type: bearer
      token: '{{env.UMAMI_API_KEY}}'
  exposes:
  - type: rest
    namespace: umami-sessions-rest
    port: 8080
    description: REST adapter for Umami Analytics API — Sessions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/websites/{websiteid}/sessions
      name: api-websites-websiteid-sessions
      description: REST surface for api-websites-websiteId-sessions.
      operations:
      - method: GET
        name: listsessions
        description: Umami List Sessions
        call: umami-sessions.listsessions
        with:
          websiteId: rest.websiteId
          startAt: rest.startAt
          endAt: rest.endAt
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/websites/{websiteid}/sessions/stats
      name: api-websites-websiteid-sessions-stats
      description: REST surface for api-websites-websiteId-sessions-stats.
      operations:
      - method: GET
        name: getsessionstats
        description: Umami Session Stats
        call: umami-sessions.getsessionstats
        with:
          websiteId: rest.websiteId
          startAt: rest.startAt
          endAt: rest.endAt
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: umami-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Umami Analytics API — Sessions. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: umami-list-sessions
      description: Umami List Sessions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: umami-sessions.listsessions
      with:
        websiteId: tools.websiteId
        startAt: tools.startAt
        endAt: tools.endAt
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: umami-session-stats
      description: Umami Session Stats
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: umami-sessions.getsessionstats
      with:
        websiteId: tools.websiteId
        startAt: tools.startAt
        endAt: tools.endAt
      outputParameters:
      - type: object
        mapping: $.