Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Bulk Data Insertion Events API

3 actions 3 updates phrasing extends openapi/adobe-analytics-events-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 3

$.info

$.paths['/events'].post

$.paths['/events/validate'].post

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 Adobe Analytics Bulk Data Insertion Events API
  version: 1.0.0
extends: openapi/adobe-analytics-events-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: 2
- target: $.paths['/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a batch file of Analytics hits
      effect: write
      questions:
      - How do I send a gzip CSV of Analytics hits for ingestion in bulk?
      - Can I make a batch events upload idempotent so retries don't duplicate data?
      instructions:
      - text: Upload the events file {file} with VGID {x-adobe-vgid}.
        slots:
          file: requestBody.file
          x-adobe-vgid: header.x-adobe-vgid
      - text: Ingest batch file {file} under VGID {x-adobe-vgid} with idempotency key {x-adobe-idempotency-key}.
        slots:
          file: requestBody.file
          x-adobe-vgid: header.x-adobe-vgid
          x-adobe-idempotency-key: header.x-adobe-idempotency-key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/events/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a batch events file without ingesting
      effect: read
      questions:
      - Can I check whether my batch events CSV is formatted correctly before uploading it?
      - Is there a dry run that validates an events file without ingesting the data?
      instructions:
      - text: Validate events file {file} for VGID {x-adobe-vgid} without ingesting it.
        slots:
          file: requestBody.file
          x-adobe-vgid: header.x-adobe-vgid
      - text: Dry-run check that {file} passes format validation.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'