Mapp Marketing Cloud Usage Statistics API

openapi: 3.2.0
info:
  title: Mapp Engage public Usage Statistics API
  version: '1'
  description: 'Mapp Engage REST API (REST 2.0, incremental version v19). Assembled verbatim from the per-operation OpenAPI fragments Mapp publishes on each endpoint page of https://docs.mapp.com/apidocs/. The base URL is tenant-specific: take your Mapp Engage login host and append /api/rest/v19.'
  contact:
    name: Mapp Technical Support
    url: https://mapp.com/tech-support/
servers:
- url: /api/rest/v19
security:
- basicAuth: []
tags:
- name: Usage Statistics
paths:
  /usagestatistics/export:
    get:
      tags:
      - Usage Statistics
      summary: Export usage statistics
      description: 'Export usage statistics

        Notes: If the request to generate export is successful, then show "Usage Statistics Export Job ID is being generated. The notification user will receive an email when the export is ready."


        If the request to generate export is unsuccessful, then show "The request has failed. Please get in touch with your Account Representative and quote [API error code]."

        Request body example:


        {

        "entityKey": "23",

        "code": null,

        "message": "Usage Statistics Export with exportDefinitonId entity key is being generated. The notification user will receive an email when the export is ready."

        }'
      operationId: ExportGetUsageStatistics
      parameters:
      - name: fromDate
        in: query
        description: From date request
        required: true
        schema:
          type: string
      - name: toDate
        in: query
        description: To date request
        required: true
        schema:
          type: string
      - name: format
        in: query
        required: true
        schema:
          type: string
      - name: destination
        in: query
        required: true
        schema:
          type: string
      - name: notificationUser
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CallResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/CallResult'
        '400':
          description: ''
  /usagestatistics/get:
    get:
      tags:
      - Usage Statistics
      summary: Get usage statistics
      description: 'Get usage statistics

        Request body example:


        {

        "name": "totalnoofapi2.0callsresponsesize_/usagestatistics/get",

        "description": "Total no. of API 2.0 response sizes sent per method",

        "unit": "MB",

        "counters": [

        {

        "timestamp": "2020-08-01",

        "value": "0,11"

        },

        {

        "timestamp": "2020-08-02",

        "value": "0,11"

        }

        ]

        }'
      operationId: getUsageStatistics
      parameters:
      - name: fromDate
        in: query
        description: The start of the time period to request.
        required: true
        schema:
          type: string
      - name: toDate
        in: query
        description: The end of the time period to request.
        required: true
        schema:
          type: string
      - name: aggregationPeriod
        in: query
        description: The aggregation period. The options are auto (default), daily, or monthly.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageStatisticsCounters'
            application/xml:
              schema:
                $ref: '#/components/schemas/UsageStatisticsCounters'
        '400':
          description: ''
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with a Mapp Engage system user of type API (or Hybrid).
x-apievangelist-provenance:
  method: searched
  generated: '2026-08-12'
  source: https://docs.mapp.com/apidocs/ (per-endpoint OpenAPI fragments)
  note: Union of the OpenAPI JSON fragments Mapp publishes on each endpoint page. Mapp does not serve one consolidated document at a public URL; the tenant-served Swagger lives at https://<your-engage-host>/apidoc/swagger.json and requires a tenant. Operation bodies, parameters, responses, tags, summaries and descriptions are verbatim from Mapp. The swagger/basePath/schemes/securityDefinitions envelope is added by API Evangelist from the published Getting Started guide; no operation content was authored.
  duplicate_operation_ids_suffixed: 30