# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Taboola Backstage Conversions Conversion Rules API
  version: 1.0.0
extends: openapi/taboola-conversion-rules-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: 6
- target: $.paths['/{account_id}/conversion_rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List an account's conversion rules
      effect: read
      questions:
      - What conversion rules are set up on my account?
      - Can I list every conversion rule along with its status?
      instructions:
      - text: List all conversion rules for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show the conversion rules configured in {account_id}.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/conversion_rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a conversion rule
      effect: write
      questions:
      - How do I start tracking a new conversion event like a purchase?
      - Can I set a lookback window when I create a conversion rule?
      instructions:
      - text: Create a conversion rule named {display_name} for event {event_name} in account {account_id}.
        slots:
          display_name: requestBody.display_name
          event_name: requestBody.event_name
          account_id: path.account_id
      - text: Add a new conversion rule {display_name} with a {look_back_window}-day lookback window.
        slots:
          display_name: requestBody.display_name
          look_back_window: requestBody.look_back_window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/conversion_rules/plus_data'].get
  update:
    x-apievangelist-phrasing:
      intent: List conversion rules with their data
      effect: read
      questions:
      - How many conversions has each of my conversion rules recorded?
      - Can I get my conversion rules together with aggregated stats per rule?
      instructions:
      - text: List conversion rules with aggregated data for account {account_id}.
        slots:
          account_id: path.account_id
      - text: Show each conversion rule in {account_id} alongside its conversion totals.
        slots:
          account_id: path.account_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/conversion_rules/{rule_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one conversion rule
      effect: read
      questions:
      - How do I look up a single conversion rule by its ID?
      - Can I check the condition and lookback window of one specific rule?
      instructions:
      - text: Get conversion rule {rule_id} in account {account_id}.
        slots:
          rule_id: path.rule_id
          account_id: path.account_id
      - text: Show the settings of conversion rule {rule_id}.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/conversion_rules/{rule_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a conversion rule
      effect: write
      questions:
      - How do I rename or change an existing conversion rule?
      - Can I change whether a rule counts toward total conversions?
      instructions:
      - text: Rename existing conversion rule {rule_id} in account {account_id} to {display_name}.
        slots:
          rule_id: path.rule_id
          display_name: requestBody.display_name
          account_id: path.account_id
      - text: Set the lookback window on conversion rule {rule_id} to {look_back_window} days.
        slots:
          rule_id: path.rule_id
          look_back_window: requestBody.look_back_window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{account_id}/conversion_rules/{rule_id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a conversion rule
      effect: destructive
      questions:
      - How do I retire a conversion rule I no longer use?
      - Can I archive a conversion rule instead of editing it?
      instructions:
      - text: Archive conversion rule {rule_id} in account {account_id}.
        slots:
          rule_id: path.rule_id
          account_id: path.account_id
      - text: Stop using conversion rule {rule_id} by archiving it.
        slots:
          rule_id: path.rule_id
      method: generated
      generated: '2026-09-26'