Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Real-time Customer Profile Profile preview API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/ups/previewsamplestatus'].get
$.paths['/ups/previewsamplestatus/report/dataset'].get
$.paths['/ups/previewsamplestatus/report/namespace'].get

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 Real-time Customer Profile Profile preview API
  version: 1.0.0
extends: openapi/adobe-suite-profile-preview-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: 3
- target: $.paths['/ups/previewsamplestatus'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the last profile sample job
      effect: read
      questions:
      - When did the last successful profile sample job run?
      - How many profiles are in my Real-Time Customer Profile store right now?
      instructions:
      - text: Show the status of the last profile sample job in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      - text: Preview the latest successful profile sample.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/previewsamplestatus/report/dataset'].get
  update:
    x-apievangelist-phrasing:
      intent: Report profile counts by dataset
      effect: read
      questions:
      - Which datasets contribute the most profiles?
      - Can I see the profile distribution by dataset for a specific date?
      instructions:
      - text: Show the profile-by-dataset report in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      - text: Get the dataset overlap report for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ups/previewsamplestatus/report/namespace'].get
  update:
    x-apievangelist-phrasing:
      intent: Report profile counts by identity namespace
      effect: read
      questions:
      - How are profiles distributed across identity namespaces like email or ECID?
      - Can I get the namespace breakdown of profiles from a past date?
      instructions:
      - text: Show the profile-by-namespace report in sandbox {x-sandbox-name}.
        slots:
          x-sandbox-name: header.x-sandbox-name
      - text: Get the namespace distribution report for {date}.
        slots:
          date: query.date
      method: generated
      generated: '2026-09-26'