Adobe Experience Cloud · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Experience Cloud Adobe Target Activities API

7 actions 7 updates phrasing extends openapi/adobe-experience-cloud-activities-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Experience Cloud's API. It is a proposal applied on top of the contract, not a document Adobe Experience Cloud publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/target/activities'].get
$.paths['/target/activities'].post
$.paths['/target/activities/{activityId}'].get
$.paths['/target/activities/{activityId}'].put
$.paths['/target/activities/{activityId}'].delete
$.paths['/target/activities/{activityId}/state'].put

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 Experience Cloud Adobe Target Activities API
  version: 1.0.0
extends: openapi/adobe-experience-cloud-activities-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: 6
- target: $.paths['/target/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List Target activities
      effect: read
      questions:
      - Which A/B tests and personalization activities are set up in our Adobe Target tenant?
      - Can I page through Target activities and sort them by a field?
      - What activities are currently configured for our site experiments?
      instructions:
      - text: List all my Target activities.
      - text: Show the next {limit} Target activities starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      - text: List Target activities sorted by {sortBy}.
        slots:
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Target activity
      effect: write
      questions:
      - Can I set up a new A/B test in Adobe Target through the API?
      - What do I need to provide to create an experience targeting or multivariate activity?
      - Is it possible to schedule a new activity with a start and end date when creating it?
      instructions:
      - text: Create a new {type} activity named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create activity {name} of type {type} running from {startsAt} to {endsAt}.
        slots:
          name: requestBody.name
          type: requestBody.type
          startsAt: requestBody.startsAt
          endsAt: requestBody.endsAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target/activities/{activityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Target activity's configuration
      effect: read
      questions:
      - How can I see the experiences, audiences and metrics behind one specific activity?
      - Where do I find the schedule configured for a single Target activity?
      instructions:
      - text: Show me the full configuration of activity {activityId}.
        slots:
          activityId: path.activityId
      - text: Get the experiences and scheduling for Target activity {activityId}.
        slots:
          activityId: path.activityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target/activities/{activityId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Target activity
      effect: write
      questions:
      - Can I rename an existing activity or change its priority?
      - Does updating a Target activity require sending the whole activity object?
      instructions:
      - text: Rename activity {activityId} to {name}.
        slots:
          activityId: path.activityId
          name: requestBody.name
      - text: Set the priority of activity {activityId} to {priority}, keeping name {name} and type {type}.
        slots:
          activityId: path.activityId
          priority: requestBody.priority
          name: requestBody.name
          type: requestBody.type
      - text: Move the end date of activity {activityId} to {endsAt}.
        slots:
          activityId: path.activityId
          endsAt: requestBody.endsAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target/activities/{activityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Target activity
      effect: destructive
      questions:
      - How do I permanently remove an old A/B test from Target?
      - Do I need to deactivate an activity before deleting it?
      instructions:
      - text: Delete Target activity {activityId}.
        slots:
          activityId: path.activityId
      - text: Permanently remove activity {activityId} from Target.
        slots:
          activityId: path.activityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/target/activities/{activityId}/state'].put
  update:
    x-apievangelist-phrasing:
      intent: Activate, deactivate or archive an activity
      effect: write
      questions:
      - Can I pause a running A/B test without deleting it?
      - Which state changes are allowed when activating or archiving an activity?
      - Is there a way to turn a Target activity live through the API?
      instructions:
      - text: Activate activity {activityId}.
        slots:
          activityId: path.activityId
      - text: Set the state of activity {activityId} to {state}.
        slots:
          activityId: path.activityId
          state: requestBody.state
      - text: Archive Target activity {activityId}.
        slots:
          activityId: path.activityId
      method: generated
      generated: '2026-10-01'