Khoros · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Khoros Ai Export API

11 actions 11 updates phrasing extends openapi/khoros-ai-export-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Khoros's API. It is a proposal applied on top of the contract, not a document Khoros publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/export/posts'].post
$.paths['/export/accounts'].post
$.paths['/export/daily_post_summary'].post
$.paths['/export/net_ads'].post
$.paths['/export/stream_items'].post
$.paths['/export/stream_item_actions'].post
$.paths['/export/customer_feedback'].post
$.paths['/export/profiles'].post
$.paths['/export/{id}/status'].get
$.paths['/export/{export_type}/fields'].get

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 Khoros Ai Export API
  version: 1.0.0
extends: openapi/khoros-ai-export-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: 10
- target: $.paths['/export/posts'].post
  update:
    x-apievangelist-phrasing:
      intent: Export published posts and their metrics
      effect: write
      questions:
      - How do I export the posts we published along with their engagement metrics?
      - Can a published posts export be emailed to my team when it is ready?
      instructions:
      - text: Export published posts with metrics using query {query}.
        slots:
          query: requestBody.query
      - text: Export our published posts and email the file to {email_recipients}.
        slots:
          email_recipients: query.email_recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Export daily account-level metrics
      effect: write
      questions:
      - How do I get daily performance metrics for each social account?
      - Can the daily account metrics export use a custom delimiter?
      instructions:
      - text: Export daily account-level metrics for query {query}.
        slots:
          query: requestBody.query
      - text: Export daily metrics per account delimited by {delimiter}.
        slots:
          delimiter: query.delimiter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/daily_post_summary'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a daily summary of post metrics
      effect: write
      questions:
      - Is there an export that rolls up post metrics by day?
      - How do I get a daily post summary file?
      instructions:
      - text: Export the daily post summary for query {query}.
        slots:
          query: requestBody.query
      - text: Send the daily post metrics summary to {email_recipients}.
        slots:
          email_recipients: query.email_recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/net_ads'].post
  update:
    x-apievangelist-phrasing:
      intent: Export ads with net metric values
      effect: write
      questions:
      - How do I export our ads and their net performance values?
      - Can I export ad metrics without a header row?
      instructions:
      - text: Export ads net values for query {query}.
        slots:
          query: requestBody.query
      - text: Export ad metrics with header setting {header}.
        slots:
          header: query.header
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/stream_items'].post
  update:
    x-apievangelist-phrasing:
      intent: Export stream items for a date range
      effect: write
      questions:
      - How do I export the items that landed in my streams over some dates?
      - Can a stream item export come out as CSV or JSON?
      instructions:
      - text: Export stream items matching {query}.
        slots:
          query: requestBody.query
      - text: Export stream item data in {format} format.
        slots:
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/stream_item_actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Export actions taken on stream items
      effect: write
      questions:
      - How do I export what actions were taken on stream items?
      - Is the stream item action export available as JSON?
      instructions:
      - text: Export stream item actions matching {query}.
        slots:
          query: requestBody.query
      - text: Export stream item action data as {format} and email {email_recipients}.
        slots:
          format: query.format
          email_recipients: query.email_recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/customer_feedback'].post
  update:
    x-apievangelist-phrasing:
      intent: Export customer feedback responses
      effect: write
      questions:
      - How do I export the customer feedback responses we received?
      - Can I get survey feedback for a chosen date range as a file?
      instructions:
      - text: Export customer feedback responses for {query}.
        slots:
          query: requestBody.query
      - text: Export customer feedback as {format}.
        slots:
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Export social network profile details
      effect: write
      questions:
      - How do I export information about our social network profiles?
      - What profile details can I pull into a spreadsheet?
      instructions:
      - text: Export social profiles matching {query}.
        slots:
          query: requestBody.query
      - text: Export our network profiles as {format} with delimiter {delimiter}.
        slots:
          format: query.format
          delimiter: query.delimiter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/{id}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a marketing export
      effect: read
      questions:
      - How do I know when my analytics export is ready?
      - What states can a marketing analytics export be in?
      instructions:
      - text: Check the status of export {id}.
        slots:
          id: path.id
      - text: Tell me whether export {id} has finished.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/export/{export_type}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields available for an export type
      effect: read
      questions:
      - Which fields can I include in a given export type?
      - What columns are available for the posts export?
      instructions:
      - text: List the available fields for export type {export_type}.
        slots:
          export_type: path.export_type
      - text: Show which report columns {export_type} exports support.
        slots:
          export_type: path.export_type
      method: generated
      generated: '2026-10-01'