Brevo Transactional SMS API — SMS Statistics

naftiko: 1.0.0-alpha2
info:
  label: Brevo Transactional SMS API — SMS Statistics
  description: 'Brevo Transactional SMS API — SMS Statistics. 3 operations. Lead operation: Get aggregated transactional SMS
    statistics. Self-contained Naftiko capability covering one Brevo business surface.'
  tags:
  - Brevo
  - SMS Statistics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BREVO_API_KEY: BREVO_API_KEY
capability:
  consumes:
  - type: http
    namespace: transactional-sms-sms-statistics
    baseUri: https://api.brevo.com/v3
    description: Brevo Transactional SMS API — SMS Statistics business capability. Self-contained, no shared references.
    resources:
    - name: transactionalSMS-statistics-aggregatedReport
      path: /transactionalSMS/statistics/aggregatedReport
      operations:
      - name: getaggregatedsmsreport
        method: GET
        description: Get aggregated transactional SMS statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Start date for the report in YYYY-MM-DD format.
        - name: endDate
          in: query
          type: string
          description: End date for the report in YYYY-MM-DD format.
        - name: days
          in: query
          type: integer
          description: Number of days for the report, starting from today.
        - name: tag
          in: query
          type: string
          description: Filter by tag.
    - name: transactionalSMS-statistics-events
      path: /transactionalSMS/statistics/events
      operations:
      - name: getsmsevents
        method: GET
        description: Get transactional SMS activity events
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Start date for the event query in YYYY-MM-DD format.
        - name: endDate
          in: query
          type: string
          description: End date for the event query in YYYY-MM-DD format.
        - name: phoneNumber
          in: query
          type: string
          description: Filter events by recipient phone number.
        - name: event
          in: query
          type: string
          description: Filter by event type such as delivered, sent, softBounce, hardBounce, or unsubscribed.
        - name: tags
          in: query
          type: string
          description: Filter events by tag assigned to the SMS.
    - name: transactionalSMS-statistics-reports
      path: /transactionalSMS/statistics/reports
      operations:
      - name: getsmsreports
        method: GET
        description: Get transactional SMS statistics reports
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: startDate
          in: query
          type: string
          description: Start date for the report in YYYY-MM-DD format.
        - name: endDate
          in: query
          type: string
          description: End date for the report in YYYY-MM-DD format.
        - name: days
          in: query
          type: integer
          description: Number of days for the report, starting from today.
        - name: tag
          in: query
          type: string
          description: Filter reports by tag.
    authentication:
      type: apikey
      key: api-key
      value: '{{env.BREVO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: transactional-sms-sms-statistics-rest
    port: 8080
    description: REST adapter for Brevo Transactional SMS API — SMS Statistics. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/transactionalsms/statistics/aggregatedreport
      name: transactionalsms-statistics-aggregatedreport
      description: REST surface for transactionalSMS-statistics-aggregatedReport.
      operations:
      - method: GET
        name: getaggregatedsmsreport
        description: Get aggregated transactional SMS statistics
        call: transactional-sms-sms-statistics.getaggregatedsmsreport
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          days: rest.days
          tag: rest.tag
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactionalsms/statistics/events
      name: transactionalsms-statistics-events
      description: REST surface for transactionalSMS-statistics-events.
      operations:
      - method: GET
        name: getsmsevents
        description: Get transactional SMS activity events
        call: transactional-sms-sms-statistics.getsmsevents
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          phoneNumber: rest.phoneNumber
          event: rest.event
          tags: rest.tags
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/transactionalsms/statistics/reports
      name: transactionalsms-statistics-reports
      description: REST surface for transactionalSMS-statistics-reports.
      operations:
      - method: GET
        name: getsmsreports
        description: Get transactional SMS statistics reports
        call: transactional-sms-sms-statistics.getsmsreports
        with:
          startDate: rest.startDate
          endDate: rest.endDate
          days: rest.days
          tag: rest.tag
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: transactional-sms-sms-statistics-mcp
    port: 9090
    transport: http
    description: MCP adapter for Brevo Transactional SMS API — SMS Statistics. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: get-aggregated-transactional-sms-statistics
      description: Get aggregated transactional SMS statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-sms-sms-statistics.getaggregatedsmsreport
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        days: tools.days
        tag: tools.tag
      outputParameters:
      - type: object
        mapping: $.
    - name: get-transactional-sms-activity-events
      description: Get transactional SMS activity events
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-sms-sms-statistics.getsmsevents
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        phoneNumber: tools.phoneNumber
        event: tools.event
        tags: tools.tags
      outputParameters:
      - type: object
        mapping: $.
    - name: get-transactional-sms-statistics-reports
      description: Get transactional SMS statistics reports
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: transactional-sms-sms-statistics.getsmsreports
      with:
        startDate: tools.startDate
        endDate: tools.endDate
        days: tools.days
        tag: tools.tag
      outputParameters:
      - type: object
        mapping: $.