# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Tapfiliate REST Conversions API version: 1.0.0 extends: openapi/tapfiliate-conversions-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: 11 - target: $.paths['/conversions/{conversion_id}/'].get update: x-apievangelist-phrasing: intent: Retrieve a conversion effect: read questions: - Can I look up one conversion by its ID? - What details are recorded on a single conversion? instructions: - text: Get conversion {conversion_id}. slots: conversion_id: path.conversion_id - text: Show me conversion {conversion_id} and its details. slots: conversion_id: path.conversion_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/'].delete update: x-apievangelist-phrasing: intent: Delete a conversion effect: destructive questions: - How do I delete a conversion that was recorded by mistake? - Can I remove a fraudulent conversion entirely? instructions: - text: Delete conversion {conversion_id}. slots: conversion_id: path.conversion_id - text: Remove the conversion record {conversion_id}. slots: conversion_id: path.conversion_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/'].patch update: x-apievangelist-phrasing: intent: Update a conversion effect: write questions: - Can I change the amount on a conversion after it was tracked? - Is it possible to correct the external ID on an existing conversion? instructions: - text: Change the amount of conversion {conversion_id} to {amount}. slots: conversion_id: path.conversion_id amount: requestBody.amount - text: Set the external ID of conversion {conversion_id} to {external_id}. slots: conversion_id: path.conversion_id external_id: requestBody.external_id - text: Update conversion {conversion_id} with metadata {meta_data}. slots: conversion_id: path.conversion_id meta_data: requestBody.meta_data method: generated generated: '2026-10-01' - target: $.paths['/conversions/'].get update: x-apievangelist-phrasing: intent: List conversions effect: read questions: - Which conversions happened between two dates? - Can I see only the conversions for one affiliate or one program? - Where do I find all the sales my affiliates have referred? instructions: - text: List conversions from {date_from} to {date_to}. slots: date_from: query.date_from date_to: query.date_to - text: Show conversions for affiliate {affiliate_id}. slots: affiliate_id: query.affiliate_id - text: List conversions in program {program_id}. slots: program_id: query.program_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/'].post update: x-apievangelist-phrasing: intent: Record a conversion effect: write questions: - How do I track a sale and credit it to an affiliate? - Can I attribute a new conversion to a specific click? - What amount should I send for a revenue-based commission? instructions: - text: Record a conversion of {amount} in program {program_id}. slots: amount: requestBody.amount program_id: requestBody.program_id - text: Create a conversion in program {program_id} for click {click_id} with order ID {external_id}. slots: program_id: requestBody.program_id click_id: requestBody.click_id external_id: requestBody.external_id - text: Track a conversion in program {program_id} for customer {customer_id} using commission type {commission_type}. slots: program_id: requestBody.program_id customer_id: requestBody.customer_id commission_type: requestBody.commission_type method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/commissions/'].post update: x-apievangelist-phrasing: intent: Add commissions to a conversion effect: write questions: - Can I add extra commission entries to a conversion that already exists? - How do I attach another commission to a recorded conversion? instructions: - text: Add commissions to conversion {conversion_id}. slots: conversion_id: path.conversion_id - text: Attach additional commission entries to existing conversion {conversion_id}. slots: conversion_id: path.conversion_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/meta-data/'].get update: x-apievangelist-phrasing: intent: Get all metadata for a conversion effect: read questions: - What custom metadata is stored on a conversion? - Can I fetch every metadata key on one conversion at once? instructions: - text: Get all metadata for conversion {conversion_id}. slots: conversion_id: path.conversion_id - text: Show the full metadata set on conversion {conversion_id}. slots: conversion_id: path.conversion_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/meta-data/'].put update: x-apievangelist-phrasing: intent: Replace a conversion's metadata effect: write questions: - Can I overwrite a conversion's whole metadata object in one go? - What happens to old conversion metadata keys when I replace them all? instructions: - text: Replace all metadata on conversion {conversion_id}. slots: conversion_id: path.conversion_id - text: Overwrite the entire metadata set for conversion {conversion_id}. slots: conversion_id: path.conversion_id method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/meta-data/{key}/'].get update: x-apievangelist-phrasing: intent: Get one metadata key for a conversion effect: read questions: - Can I read one metadata value from a conversion by its key? - What value does a conversion hold for a given metadata key? instructions: - text: Get metadata key {key} for conversion {conversion_id}. slots: conversion_id: path.conversion_id key: path.key - text: Show conversion {conversion_id}'s {key} metadata value. slots: conversion_id: path.conversion_id key: path.key method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/meta-data/{key}/'].put update: x-apievangelist-phrasing: intent: Set one metadata key on a conversion effect: write questions: - Can I set a single metadata key on a conversion without touching the rest? - Is there a way to update one conversion metadata field? instructions: - text: Set metadata key {key} on conversion {conversion_id}. slots: conversion_id: path.conversion_id key: path.key - text: Update only the {key} metadata field for conversion {conversion_id}. slots: conversion_id: path.conversion_id key: path.key method: generated generated: '2026-10-01' - target: $.paths['/conversions/{conversion_id}/meta-data/{key}/'].delete update: x-apievangelist-phrasing: intent: Delete one metadata key from a conversion effect: destructive questions: - Can I remove a single metadata key from a conversion? - How do I drop one custom field from a conversion's metadata? instructions: - text: Delete metadata key {key} from conversion {conversion_id}. slots: conversion_id: path.conversion_id key: path.key - text: Remove the {key} metadata entry on conversion {conversion_id}. slots: conversion_id: path.conversion_id key: path.key method: generated generated: '2026-10-01'