Mapp Marketing Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mapp Engage public Usage Statistics API

3 actions 3 updates phrasing extends openapi/mapp-usage-statistics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Mapp Marketing Cloud's API. It is a proposal applied on top of the contract, not a document Mapp Marketing Cloud publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/usagestatistics/export'].get

$.paths['/usagestatistics/get'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mapp Engage public Usage Statistics API
  version: 1.0.0
extends: openapi/mapp-usage-statistics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/usagestatistics/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export account usage statistics
      effect: read
      questions:
      - Can I get our API usage statistics emailed as an export file?
      - Who is notified when a usage statistics export is ready?
      instructions:
      - text: Export usage statistics from {fromDate} to {toDate} as {format} to {destination} and notify {notificationUser}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
          format: query.format
          destination: query.destination
          notificationUser: query.notificationUser
      - text: Generate a usage export for {fromDate} through {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usagestatistics/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account usage statistics
      effect: read
      questions:
      - How many API calls did we make last month?
      - Can usage figures be aggregated by day or month?
      instructions:
      - text: Show usage statistics from {fromDate} to {toDate}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Get usage from {fromDate} to {toDate} aggregated by {aggregationPeriod}.
        slots:
          fromDate: query.fromDate
          toDate: query.toDate
          aggregationPeriod: query.aggregationPeriod
      method: generated
      generated: '2026-09-26'