Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Data Sources Job API

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

$.info

$.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}'].get

$.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}'].post

$.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}/{job_id}'].get

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 Data Sources Job API
  version: 1.0.0
extends: openapi/adobe-analytics-job-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: 3
- target: $.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploads to a Data Sources account
      effect: read
      questions:
      - What files have been uploaded to my Data Sources account and did they process?
      - Can I filter Data Sources upload jobs by status or date range?
      instructions:
      - text: List jobs for Data Sources account {data_source_id} on report suite {report_suite_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
      - text: Show {status} Data Sources jobs on {report_suite_id} account {data_source_id} since {start_date}.
        slots:
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
          status: query.status
          start_date: query.start_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a data file to a Data Sources account
      effect: write
      questions:
      - How do I upload offline data to a Data Sources account through the API?
      - Does a Data Sources API upload need the same file format as an FTP upload?
      instructions:
      - text: Upload a data file to Data Sources account {data_source_id} on report suite {report_suite_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
      - text: Send my Data Sources file to account {data_source_id} on {report_suite_id}.
        slots:
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/datasources/job/{report_suite_id}/{data_source_id}/{job_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Data Sources upload job
      effect: read
      questions:
      - How do I check whether one specific Data Sources upload succeeded?
      - What is the processing status of a Data Sources job by its job ID?
      instructions:
      - text: Get Data Sources job {job_id} for account {data_source_id} on report suite {report_suite_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          job_id: path.job_id
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
      - text: Check status of upload job {job_id} on {report_suite_id} account {data_source_id}.
        slots:
          report_suite_id: path.report_suite_id
          data_source_id: path.data_source_id
          job_id: path.job_id
      method: generated
      generated: '2026-10-01'