Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics 2.0 Component Migration API. Metrics mappings API

5 actions 5 updates phrasing extends openapi/adobe-analytics-metrics-mappings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Analytics's API. It is a proposal applied on top of the contract, not a document Adobe Analytics publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/mapping/metrics/csv'].get
$.paths['/mapping/metrics/csv'].put
$.paths['/mapping/metrics/csv'].post
$.paths['/mapping/metrics/all'].delete

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics 2.0 Component Migration API. Metrics mappings API
  version: 1.0.0
extends: openapi/adobe-analytics-metrics-mappings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/mapping/metrics/csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download metric mappings as CSV
      effect: read
      questions:
      - How do I export the metric mappings between a report suite and a data view?
      - Can I download mappings for only selected metrics?
      instructions:
      - text: Download metric mappings CSV for report suite {rsid} and data view {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
      - text: Export mappings for metrics {metricIds} on {rsid} and data view {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
          metricIds: query.metricIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mapping/metrics/csv'].put
  update:
    x-apievangelist-phrasing:
      intent: Update metric mappings from CSV
      effect: write
      questions:
      - Can I edit existing metric mappings by uploading a revised CSV?
      - How do I change some metric mappings for a report suite and data view?
      instructions:
      - text: Update metric mappings for {rsid} and data view {dataId} with CSV {file}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
          file: requestBody.file
      - text: Apply my edited metric mapping CSV {file} to report suite {rsid}, data view {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mapping/metrics/csv'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace metric mappings with a CSV
      effect: write
      questions:
      - How do I upload a CSV that overrides all current metric mappings?
      - Can I create fresh metric mappings for a report suite from a file?
      instructions:
      - text: Upload CSV {file} to override metric mappings for {rsid} and data view {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
          file: requestBody.file
      - text: Create new metric mappings on report suite {rsid}, data view {dataId}, from {file}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/mapping/metrics/all'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete all metric mappings
      effect: destructive
      questions:
      - How do I wipe every metric mapping for a report suite and data view?
      - Does clearing metric mappings fail if there are none?
      instructions:
      - text: Delete all metric mappings for report suite {rsid} and data view {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
      - text: Clear every metric mapping between {rsid} and {dataId}.
        slots:
          rsid: query.rsid
          dataId: query.dataId
      method: generated
      generated: '2026-10-01'