Litmus Email Analytics API — Analytics

naftiko: 1.0.0-alpha2
info:
  label: Litmus Email Analytics API — Analytics
  description: 'Litmus Email Analytics API — Analytics. 5 operations. Lead operation: Litmus Get campaign email client breakdown.
    Self-contained Naftiko capability covering one Litmus business surface.'
  tags:
  - Litmus
  - Analytics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LITMUS_API_KEY: LITMUS_API_KEY
capability:
  consumes:
  - type: http
    namespace: email-analytics-analytics
    baseUri: https://analytics-api.litmus.com/api/v1
    description: Litmus Email Analytics API — Analytics business capability. Self-contained, no shared references.
    resources:
    - name: campaigns-campaignGuid-clients
      path: /campaigns/{campaignGuid}/clients
      operations:
      - name: getcampaignclientbreakdown
        method: GET
        description: Litmus Get campaign email client breakdown
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: campaigns-campaignGuid-devices
      path: /campaigns/{campaignGuid}/devices
      operations:
      - name: getcampaigndevicebreakdown
        method: GET
        description: Litmus Get campaign device breakdown
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: campaigns-campaignGuid-geo
      path: /campaigns/{campaignGuid}/geo
      operations:
      - name: getcampaigngeobreakdown
        method: GET
        description: Litmus Get campaign geographic breakdown
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: campaigns-campaignGuid-read-times
      path: /campaigns/{campaignGuid}/read-times
      operations:
      - name: getcampaignreadtimes
        method: GET
        description: Litmus Get campaign read time distribution
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: campaigns-campaignGuid-summary
      path: /campaigns/{campaignGuid}/summary
      operations:
      - name: getcampaignsummary
        method: GET
        description: Litmus Get campaign engagement summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.LITMUS_USER}}'
      password: '{{env.LITMUS_PASS}}'
  exposes:
  - type: rest
    namespace: email-analytics-analytics-rest
    port: 8080
    description: REST adapter for Litmus Email Analytics API — Analytics. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/campaigns/{campaignguid}/clients
      name: campaigns-campaignguid-clients
      description: REST surface for campaigns-campaignGuid-clients.
      operations:
      - method: GET
        name: getcampaignclientbreakdown
        description: Litmus Get campaign email client breakdown
        call: email-analytics-analytics.getcampaignclientbreakdown
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{campaignguid}/devices
      name: campaigns-campaignguid-devices
      description: REST surface for campaigns-campaignGuid-devices.
      operations:
      - method: GET
        name: getcampaigndevicebreakdown
        description: Litmus Get campaign device breakdown
        call: email-analytics-analytics.getcampaigndevicebreakdown
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{campaignguid}/geo
      name: campaigns-campaignguid-geo
      description: REST surface for campaigns-campaignGuid-geo.
      operations:
      - method: GET
        name: getcampaigngeobreakdown
        description: Litmus Get campaign geographic breakdown
        call: email-analytics-analytics.getcampaigngeobreakdown
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{campaignguid}/read-times
      name: campaigns-campaignguid-read-times
      description: REST surface for campaigns-campaignGuid-read-times.
      operations:
      - method: GET
        name: getcampaignreadtimes
        description: Litmus Get campaign read time distribution
        call: email-analytics-analytics.getcampaignreadtimes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/campaigns/{campaignguid}/summary
      name: campaigns-campaignguid-summary
      description: REST surface for campaigns-campaignGuid-summary.
      operations:
      - method: GET
        name: getcampaignsummary
        description: Litmus Get campaign engagement summary
        call: email-analytics-analytics.getcampaignsummary
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: email-analytics-analytics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Litmus Email Analytics API — Analytics. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: litmus-get-campaign-email-client
      description: Litmus Get campaign email client breakdown
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-analytics.getcampaignclientbreakdown
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-campaign-device-breakdown
      description: Litmus Get campaign device breakdown
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-analytics.getcampaigndevicebreakdown
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-campaign-geographic-breakdown
      description: Litmus Get campaign geographic breakdown
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-analytics.getcampaigngeobreakdown
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-campaign-read-time
      description: Litmus Get campaign read time distribution
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-analytics.getcampaignreadtimes
      outputParameters:
      - type: object
        mapping: $.
    - name: litmus-get-campaign-engagement-summary
      description: Litmus Get campaign engagement summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: email-analytics-analytics.getcampaignsummary
      outputParameters:
      - type: object
        mapping: $.