Treasure Data · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for api-v2 Postback API

2 actions 2 updates phrasing extends openapi/treasure-data-postback-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Treasure Data's API. It is a proposal applied on top of the contract, not a document Treasure Data publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/postback/v3/event/{database_name}/{table_name}'].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 api-v2 Postback API
  version: 1.0.0
extends: openapi/treasure-data-postback-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: 1
- target: $.paths['/postback/v3/event/{database_name}/{table_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an event record into a table
      effect: write
      questions:
      - How do I stream a single event into a Treasure Data table over HTTP?
      - Can I pass the write key in the URL, or must it go in a header?
      - Why does an event post return 200 even when the API key is wrong?
      instructions:
      - text: Post this event to table {table_name} in database {database_name}.
        slots:
          table_name: path.table_name
          database_name: path.database_name
      - text: Log a record to {database_name}.{table_name} through the postback endpoint.
        slots:
          database_name: path.database_name
          table_name: path.table_name
      method: generated
      generated: '2026-09-26'