Profound · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for External Reports API

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

What the actions change

x-apievangelist-phrasing

Targets 63 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/reports/citations'].post
$.paths['/v1/reports/citations/stream'].post
$.paths['/v1/reports/visibility'].post
$.paths['/v1/reports/visibility/stream'].post
$.paths['/v1/reports/sentiment'].post
$.paths['/v1/reports/sentiment/stream'].post
$.paths['/v1/reports/sentiment-v2'].post
$.paths['/v1/reports/web-search-results'].post
$.paths['/v1/reports/web-search-results/stream'].post
$.paths['/v1/reports/referrals'].post
$.paths['/v1/reports/bots'].post
$.paths['/v1/reports/query-fanouts'].post
$.paths['/v1/reports/shopping/visibility'].post
$.paths['/v1/reports/shopping/item-visibility'].post
$.paths['/v1/reports/shopping/merchant-distribution'].post

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 External Reports API
  version: 1.0.0
extends: openapi/profound-reports-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: 62
- target: $.paths['/v1/reports/citations'].post
  update:
    x-apievangelist-phrasing:
      intent: Report which sources AI answers cite
      effect: read
      questions:
      - Which websites do AI answers cite most in my category?
      - Can I limit a citations report to pages that mention my brand?
      - What is my citation share over a date range?
      instructions:
      - text: Report citation {metrics} for category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Break down cited domains in category {category_id} by {dimensions} between {start_date} and {end_date}, measuring {metrics}.
        slots:
          dimensions: requestBody.dimensions
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/citations/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream the v1 citations report
      effect: read
      questions:
      - Can I stream a big citations report row by row rather than paginate it?
      - Does the streaming citations export honor the same filters as the regular report?
      instructions:
      - text: Stream citation {metrics} rows for category {category_id}, {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Open a v1 cited-sources stream for category {category_id} over {start_date}–{end_date} with filters {filters} and metrics {metrics}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          filters: requestBody.filters
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/visibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Report brand visibility in AI answers
      effect: read
      questions:
      - How visible is my brand in AI-generated answers compared with competitors?
      - Can I track my visibility score week over week for a category?
      instructions:
      - text: Report visibility {metrics} for category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show brand visibility in category {category_id} by {date_interval} between {start_date} and {end_date}, measuring {metrics}.
        slots:
          date_interval: requestBody.date_interval
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/visibility/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream the v1 visibility report
      effect: read
      questions:
      - Is there a streaming version of the original visibility report?
      - Can I export a long visibility history as a stream?
      instructions:
      - text: Stream visibility {metrics} for category {category_id}, {start_date} through {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Open a v1 brand-presence stream for category {category_id} over {start_date}–{end_date} split by {dimensions} with metrics {metrics}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          dimensions: requestBody.dimensions
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/sentiment'].post
  update:
    x-apievangelist-phrasing:
      intent: Report sentiment toward brands in AI answers
      effect: read
      questions:
      - Do AI answers talk about my brand positively or negatively?
      - Can I see sentiment trends for my category over time?
      instructions:
      - text: Report sentiment {metrics} for category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Break down v1 tone of AI mentions in category {category_id} by {dimensions}, {start_date} to {end_date}, metrics {metrics}.
        slots:
          dimensions: requestBody.dimensions
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/sentiment/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream the v1 sentiment report
      effect: read
      questions:
      - Can I stream the original sentiment report rather than wait for one big response?
      - How do I export months of sentiment rows without paging?
      instructions:
      - text: Stream sentiment {metrics} for category {category_id}, {start_date} through {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Open a v1 tone stream for category {category_id} across {start_date}–{end_date} with filters {filters} and metrics {metrics}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          filters: requestBody.filters
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/sentiment-v2'].post
  update:
    x-apievangelist-phrasing:
      intent: Report sentiment for one named brand
      effect: read
      questions:
      - What's the sentiment toward one specific brand by name, compared with a prior period?
      - Can I bucket a single brand's sentiment by week on the sentiment-v2 route?
      instructions:
      - text: Report sentiment {metrics} for brand {asset_name} in category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          asset_name: requestBody.asset_name
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Compare {asset_name} sentiment {metrics} in {category_id}, {start_date}–{end_date} vs {comparison_start_date}–{comparison_end_date}, by {date_bucket}.
        slots:
          asset_name: requestBody.asset_name
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          comparison_start_date: requestBody.comparison_start_date
          comparison_end_date: requestBody.comparison_end_date
          date_bucket: requestBody.date_bucket
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/web-search-results'].post
  update:
    x-apievangelist-phrasing:
      intent: Report web search results behind AI answers
      effect: read
      questions:
      - Which web search results do AI engines pull up for my category's prompts?
      - Can I count how often a domain appears in AI web searches?
      instructions:
      - text: Report web search result {metrics} for category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show the search-engine results AI fetched in category {category_id} by {dimensions}, {start_date} to {end_date}, metrics {metrics}.
        slots:
          dimensions: requestBody.dimensions
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/web-search-results/stream'].post
  update:
    x-apievangelist-phrasing:
      intent: Stream the web search results report
      effect: read
      questions:
      - Can I stream all the web search results behind AI answers?
      - Is there a streaming export of retrieved search results for a long date range?
      instructions:
      - text: Stream web search result {metrics} for category {category_id}, {start_date} through {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Open a stream of retrieved search listings for category {category_id} over {start_date}–{end_date} with filters {filters} and metrics {metrics}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          filters: requestBody.filters
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/referrals'].post
  update:
    x-apievangelist-phrasing:
      intent: Report daily human referrals from AI
      effect: read
      questions:
      - How much daily referral traffic are AI assistants sending to my site?
      - Can I get day-level referral numbers across a long period efficiently?
      instructions:
      - text: Report daily referral {metrics} for {domain} since {start_date}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
      - text: Pull day-by-day referral {metrics} for {domain} between {start_date} and {end_date}.
        slots:
          domain: requestBody.domain
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/bots'].post
  update:
    x-apievangelist-phrasing:
      intent: Report daily AI bot traffic to a domain
      effect: read
      questions:
      - How many AI crawler visits did my site get each day?
      - Can I see daily counts of training versus indexing bot events over a long date range?
      instructions:
      - text: Report daily bot {metrics} for {domain} since {start_date}.
        slots:
          metrics: requestBody.metrics
          domain: requestBody.domain
          start_date: requestBody.start_date
      - text: Pull the day-level crawler {metrics} for {domain} from {start_date} to {end_date}.
        slots:
          domain: requestBody.domain
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/query-fanouts'].post
  update:
    x-apievangelist-phrasing:
      intent: Report AI query fan-outs
      effect: read
      questions:
      - What follow-up searches do AI engines fan out to when answering my prompts?
      - Can I count the sub-queries generated per prompt in a category?
      instructions:
      - text: Report query fan-out {metrics} for category {category_id} from {start_date} to {end_date}.
        slots:
          metrics: requestBody.metrics
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show the sub-searches AI ran in category {category_id} grouped by {dimensions}, {start_date} to {end_date}, using the v1 fan-out report with metrics {metrics}.
        slots:
          dimensions: requestBody.dimensions
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          metrics: requestBody.metrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/visibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Report brand visibility in AI shopping results
      effect: read
      questions:
      - How often does my brand show up in AI shopping recommendations?
      - Can I rank brands by shopping visibility against a previous period?
      instructions:
      - text: Show how often brands appear in AI shopping results for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Rank brands in AI shopping for category {category_id} by {rank_by}, {start_date} to {end_date}, versus {comparison_start_date}–{comparison_end_date}.
        slots:
          category_id: requestBody.category_id
          rank_by: requestBody.rank_by
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          comparison_start_date: requestBody.comparison_start_date
          comparison_end_date: requestBody.comparison_end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/item-visibility'].post
  update:
    x-apievangelist-phrasing:
      intent: Report product visibility in AI shopping
      effect: read
      questions:
      - Which of my products appear in AI shopping carousels, and how often?
      - Can I compare one target product against its competing items?
      instructions:
      - text: Report item-level shopping visibility for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Compare product {target_product} with up to {competitor_limit} rival items in category {category_id}, {start_date}–{end_date}.
        slots:
          target_product: requestBody.target_product
          competitor_limit: requestBody.competitor_limit
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/merchant-distribution'].post
  update:
    x-apievangelist-phrasing:
      intent: Report which merchants AI shopping shows
      effect: read
      questions:
      - Which retailers get surfaced most in AI shopping answers for my category?
      - Can I look up how often one merchant appears?
      instructions:
      - text: Show the merchant distribution for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Find how retailer {search_merchant} is spread across AI shopping in category {category_id}, {start_date}–{end_date}.
        slots:
          search_merchant: requestBody.search_merchant
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/merchant-visibility-by-brand'].post
  update:
    x-apievangelist-phrasing:
      intent: Report merchant visibility for each brand
      effect: read
      questions:
      - Which stores carry my brand when AI recommends products?
      - Can I see merchant visibility for just one brand?
      instructions:
      - text: Show merchant visibility by brand in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: List which retailers surface brand {search_brand} in category {category_id}, {start_date}–{end_date}.
        slots:
          search_brand: requestBody.search_brand
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/merchant-by-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Report merchants offering each product
      effect: read
      questions:
      - Which merchants does AI shopping list for a particular product?
      - Can I break merchants down item by item?
      instructions:
      - text: Show merchants by item in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: List the sellers shown for product {product_name} in category {category_id}, {start_date}–{end_date}.
        slots:
          product_name: requestBody.product_name
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/all-items-with-merchants'].post
  update:
    x-apievangelist-phrasing:
      intent: List all shopping items with their merchants
      effect: read
      questions:
      - Can I get the full catalog of products AI shopping showed, each with its merchants?
      - Is it possible to sort every shopping item by rank?
      instructions:
      - text: List every shopping item and its merchants for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Dump all products with sellers in category {category_id}, {start_date}–{end_date}, ranked by {rank_by} in {sort_order} order.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          rank_by: requestBody.rank_by
          sort_order: requestBody.sort_order
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/trigger-rate'].post
  update:
    x-apievangelist-phrasing:
      intent: Report how often prompts trigger shopping
      effect: read
      questions:
      - What percentage of my prompts make AI show shopping results?
      - Has the shopping trigger rate changed versus last month?
      instructions:
      - text: Report the shopping trigger rate for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Compare prompts producing product cards in {category_id}, {start_date}–{end_date} vs {comparison_start_date}–{comparison_end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          comparison_start_date: requestBody.comparison_start_date
          comparison_end_date: requestBody.comparison_end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/triggered-prompts'].post
  update:
    x-apievangelist-phrasing:
      intent: List prompts that triggered shopping results
      effect: read
      questions:
      - Which exact prompts caused AI to show shopping results?
      - Can I exclude certain topics when listing shopping-triggering prompts?
      instructions:
      - text: List prompts that triggered shopping in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show which questions led to product listings in category {category_id}, {start_date}–{end_date}, excluding topics {exclude_topic_ids}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          exclude_topic_ids: requestBody.exclude_topic_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/triggered-topics'].post
  update:
    x-apievangelist-phrasing:
      intent: List topics that triggered shopping results
      effect: read
      questions:
      - Which topics are most likely to trigger AI shopping results?
      - Can I include untagged prompts when ranking shopping-triggering topics?
      instructions:
      - text: List topics that triggered shopping in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Rank subject areas by shopping activation in category {category_id}, {start_date}–{end_date}, including untagged {include_no_tag}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          include_no_tag: requestBody.include_no_tag
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/merchant-share'].post
  update:
    x-apievangelist-phrasing:
      intent: Report merchant share for target brands
      effect: read
      questions:
      - What share of AI shopping placements does each merchant hold for my brands?
      - Can I calculate merchant share for a specific set of brands?
      instructions:
      - text: Report merchant share in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Calculate each retailer's slice of placements for brands {target_asset_names} in category {category_id}, {start_date}–{end_date}.
        slots:
          target_asset_names: requestBody.target_asset_names
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/product-merchant-urls'].post
  update:
    x-apievangelist-phrasing:
      intent: Get merchant URLs for named products
      effect: read
      questions:
      - Which merchant links does AI shopping give for my products?
      - Can I get the store URLs for a list of product names?
      instructions:
      - text: Get merchant URLs for products {product_names} in category {category_id} from {start_date} to {end_date}.
        slots:
          product_names: requestBody.product_names
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show the store links listed for {product_names} in category {category_id}, {start_date}–{end_date}.
        slots:
          product_names: requestBody.product_names
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/shopping/executions'].post
  update:
    x-apievangelist-phrasing:
      intent: List individual shopping prompt executions
      effect: read
      questions:
      - Can I see each individual prompt run that produced shopping results?
      - Is it possible to filter shopping executions by analysis type?
      instructions:
      - text: List shopping executions for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show each shopping run in category {category_id}, {start_date}–{end_date}, with analysis types {analysis_types}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          analysis_types: requestBody.analysis_types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/overview'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an overview of AI answer accuracy
      effect: read
      questions:
      - How accurately do AI answers describe my brand overall?
      - Has answer accuracy improved compared with the previous period?
      instructions:
      - text: Give me the accuracy overview for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Summarize answer correctness in category {category_id}, {start_date}–{end_date}, bucketed by {date_bucket}, grouped by {group_by}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          date_bucket: requestBody.date_bucket
          group_by: requestBody.group_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/breakdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down AI answer accuracy by dimension
      effect: read
      questions:
      - Which platforms or topics have the least accurate answers about us?
      - Can I split accuracy by region or persona and sort the results?
      instructions:
      - text: Break down accuracy by {breakdown_by} for category {category_id} from {start_date} to {end_date}.
        slots:
          breakdown_by: requestBody.breakdown_by
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Split correctness rates in category {category_id}, {start_date}–{end_date}, by {breakdown_by} sorted on {sort_by}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          breakdown_by: requestBody.breakdown_by
          sort_by: requestBody.sort_by
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/citation-analysis'].post
  update:
    x-apievangelist-phrasing:
      intent: Analyze accuracy for one cited URL
      effect: read
      questions:
      - Is a specific cited page leading AI to say inaccurate things about us?
      - Can I check accuracy for answers that cite one particular URL?
      instructions:
      - text: Analyze accuracy for cited URL {clean_href} in category {category_id} from {start_date} to {end_date}.
        slots:
          clean_href: requestBody.clean_href
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Check whether page {clean_href} drives wrong answers in category {category_id}, {start_date}–{end_date}.
        slots:
          clean_href: requestBody.clean_href
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/topic-ids'].post
  update:
    x-apievangelist-phrasing:
      intent: List topics with accuracy data
      effect: read
      questions:
      - Which topics have fact-check accuracy data in a date range?
      - Where can I get the topic IDs to filter accuracy reports by?
      instructions:
      - text: List the topic IDs with accuracy data in category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Which topics were fact-checked in category {category_id} between {start_date} and {end_date}? Get their IDs.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/inaccurate-themes'].post
  update:
    x-apievangelist-phrasing:
      intent: List recurring themes of inaccurate answers
      effect: read
      questions:
      - What recurring themes show up in AI's wrong answers about my brand?
      - Can I search inaccurate themes by keyword?
      instructions:
      - text: List inaccurate themes for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Find misinformation themes matching {search_query} in category {category_id}, {start_date}–{end_date}.
        slots:
          search_query: requestBody.search_query
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reports/accuracy/inaccurate-clusters'].post
  update:
    x-apievangelist-phrasing:
      intent: List clusters of similar inaccurate claims
      effect: read
      questions:
      - How are similar wrong claims about us grouped into clusters?
      - Can I see the inaccurate claim clusters under one theme, with the models involved?
      instructions:
      - text: List inaccurate claim clusters for category {category_id} from {start_date} to {end_date}.
        slots:
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Show the error clusters within theme {theme_id} in category {category_id}, {start_date}–{end_date}, including models {include_models}.
        slots:
          theme_id: requestBody.theme_id
          category_id: requestBody.category_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          include_models: requestBody.include_models
      method: generated
      generated: '2026-10-01'


# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/profound/refs/heads/main/overlays/profound-reports-api-phrasing-overlay.yaml