# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Console Ingestions API
  version: 1.0.0
extends: openapi/statsig-ingestions-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: 13
- target: $.paths['/console/v1/ingestion'].get
  update:
    x-apievangelist-phrasing:
      intent: Read an ingestion source
      effect: read
      questions:
      - How is data ingestion configured for a given dataset?
      - Can I look up the ingestion source for one dataset and type?
      instructions:
      - text: Show the {type} ingestion for dataset {dataset}.
        slots:
          type: query.type
          dataset: query.dataset
      - text: Get ingestion source {source_name} of type {type} for dataset {dataset}.
        slots:
          source_name: query.source_name
          type: query.type
          dataset: query.dataset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ingestion source
      effect: write
      questions:
      - How do I start ingesting data from my warehouse?
      - Can I add a new data ingestion source through the API?
      instructions:
      - text: Create a new ingestion source.
      - text: Set up data ingestion for a new source.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an ingestion source
      effect: destructive
      questions:
      - Can I stop and remove an ingestion source?
      - What's the way to delete ingestion for one dataset?
      instructions:
      - text: Delete the {type} ingestion for dataset {dataset}.
        slots:
          type: query.type
          dataset: query.dataset
      - text: Remove ingestion source {source_name} ({type}, {dataset}).
        slots:
          source_name: query.source_name
          type: query.type
          dataset: query.dataset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an ingestion source
      effect: write
      questions:
      - Can I modify an existing ingestion source's configuration?
      - Is it possible to edit ingestion settings without recreating the source?
      instructions:
      - text: Update the existing ingestion source configuration.
      - text: Edit my ingestion source settings in place.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/backfill'].post
  update:
    x-apievangelist-phrasing:
      intent: Backfill ingested data for a date range
      effect: write
      questions:
      - How do I re-ingest data for days that were missed?
      - Can I backfill only one dataset?
      instructions:
      - text: Backfill {type} dataset {dataset} from {datestamp_start} to {datestamp_end}.
        slots:
          type: requestBody.type
          dataset: requestBody.dataset
          datestamp_start: requestBody.datestamp_start
          datestamp_end: requestBody.datestamp_end
      - text: Re-run ingestion of {dataset} from source {source}, type {type}, between {datestamp_start} and {datestamp_end}.
        slots:
          dataset: requestBody.dataset
          source: requestBody.source
          type: requestBody.type
          datestamp_start: requestBody.datestamp_start
          datestamp_end: requestBody.datestamp_end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/connection/databricks'].post
  update:
    x-apievangelist-phrasing:
      intent: Connect Databricks for ingestion
      effect: write
      questions:
      - How do I connect a Databricks workspace as an ingestion source?
      - Can I use Delta Sharing credentials for the Databricks connection?
      instructions:
      - text: Connect Databricks at host {host} path {path} with token {token}.
        slots:
          host: requestBody.host
          path: requestBody.path
          token: requestBody.token
      - text: Set up the Databricks connection {host} {path} using token {token} and Delta Sharing credentials {deltaSharingCredentials}.
        slots:
          host: requestBody.host
          path: requestBody.path
          token: requestBody.token
          deltaSharingCredentials: requestBody.deltaSharingCredentials
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/events/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count ingested events over a date range
      effect: read
      questions:
      - How many events were ingested between two dates?
      - Can I count ingested rows for a single event name?
      instructions:
      - text: Count ingested events from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Count {event_name} events ingested from source {source_name} between {start_date} and {end_date}.
        slots:
          event_name: query.event_name
          source_name: query.source_name
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/events/delta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the ingestion event delta ledger
      effect: read
      questions:
      - What changed in ingested event volumes day over day?
      - Can I see the delta ledger for one ingestion source?
      instructions:
      - text: Show the ingestion delta ledger from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Get the delta ledger for {event_name} from {source_name}, {start_date} through {end_date}.
        slots:
          event_name: query.event_name
          source_name: query.source_name
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List ingestion runs
      effect: read
      questions:
      - Which ingestion jobs have run recently?
      - Can I page through past ingestion runs?
      instructions:
      - text: List recent ingestion runs.
      - text: Show page {page} of ingestion runs.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one ingestion run
      effect: read
      questions:
      - Did a specific ingestion run succeed?
      - What happened during one particular ingestion job?
      instructions:
      - text: Show ingestion run {id}.
        slots:
          id: path.id
      - text: Get the status and details of ingestion run {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a dataset's ingestion schedule
      effect: read
      questions:
      - What hour does ingestion run each day for a dataset?
      - Can I check the ingestion schedule?
      instructions:
      - text: Show the ingestion schedule for dataset {dataset}.
        slots:
          dataset: query.dataset
      - text: Tell me what hour {dataset} is ingested each day.
        slots:
          dataset: query.dataset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a dataset's ingestion schedule
      effect: write
      questions:
      - How do I move daily ingestion to a different hour?
      - Is the ingestion schedule set in Pacific time?
      instructions:
      - text: Schedule ingestion of {dataset} at {scheduled_hour_pst} Pacific.
        slots:
          dataset: requestBody.dataset
          scheduled_hour_pst: requestBody.scheduled_hour_pst
      - text: Move the daily {dataset} ingestion to hour {scheduled_hour_pst} PST.
        slots:
          dataset: requestBody.dataset
          scheduled_hour_pst: requestBody.scheduled_hour_pst
      method: generated
      generated: '2026-10-01'
- target: $.paths['/console/v1/ingestion/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check ingestion status over a date range
      effect: read
      questions:
      - Did any ingestions fail last week?
      - Can I filter ingestion status by dataset or status?
      instructions:
      - text: Show ingestion status from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: List {status} ingestions for dataset {dataset} between {startDate} and {endDate}.
        slots:
          status: query.status
          dataset: query.dataset
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'