# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Close Reporting API
  version: 1.0.0
extends: openapi/close-reporting-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: 8
- target: $.paths['/report/activity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an activity metrics report
      effect: read
      questions:
      - How many calls and emails did my team log per week last quarter?
      - Can I compare activity metrics user by user for a date range?
      instructions:
      - text: Run an activity overview report for last month.
      - text: Build an activity comparison report across all sales reps for this quarter.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/activity/metrics/'].get
  update:
    x-apievangelist-phrasing:
      intent: List metrics for activity reports
      effect: read
      questions:
      - What predefined metrics can I use in an activity report?
      - Which activity metrics are available for reporting in Close?
      instructions:
      - text: List the available activity report metrics.
      - text: Show me every metric I can put in an activity report.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/custom/{org_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Graph arbitrary metrics with Explorer
      effect: read
      questions:
      - Can I chart opportunity value by user over time like the Explorer view?
      - How do I group a custom report by a field and set the interval?
      instructions:
      - text: Run an Explorer report for organization {org_id} grouped by {group_by}.
        slots:
          org_id: path.org_id
          group_by: query.group_by
      - text: Graph {y} for organization {org_id} from {start} to {end}.
        slots:
          org_id: path.org_id
          y: query.y
          start: query.start
          end: query.end
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/funnel/opportunity/stages/'].post
  update:
    x-apievangelist-phrasing:
      intent: Get pipeline funnel stage metrics
      effect: read
      questions:
      - How many opportunities moved through each stage of my pipeline funnel?
      - Can I see stage-by-stage funnel conversion per user?
      instructions:
      - text: Get the funnel stages report for our sales pipeline.
      - text: Show per-user stage conversion in the opportunity funnel for this quarter.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/funnel/opportunity/totals/'].post
  update:
    x-apievangelist-phrasing:
      intent: Get pipeline funnel totals
      effect: read
      questions:
      - What are the overall totals for my opportunity funnel?
      - Can I export funnel totals per user as CSV?
      instructions:
      - text: Get the funnel totals report for our main pipeline.
      - text: Show the aggregated opportunity funnel totals for last month.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/sent_emails/{org_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on sent emails
      effect: read
      questions:
      - How many emails did a particular rep send last week?
      - Which email templates were sent most in a date range?
      instructions:
      - text: Get the sent emails report for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show emails sent by user {user_id} in organization {org_id} since {date_start}.
        slots:
          org_id: path.org_id
          user_id: query.user_id
          date_start: query.date_start
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/statuses/lead/{org_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on lead status changes
      effect: read
      questions:
      - How many leads moved from Potential to Qualified this month?
      - Can I limit a lead status change report to one Smart View?
      instructions:
      - text: Get the lead status change report for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show lead status changes in organization {org_id} for Smart View {smart_view_id}.
        slots:
          org_id: path.org_id
          smart_view_id: query.smart_view_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report/statuses/opportunity/{org_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Report on opportunity status changes
      effect: read
      questions:
      - How many deals were marked won or lost between two dates?
      - Can I see opportunity status changes for a single rep?
      instructions:
      - text: Get the opportunity status change report for organization {org_id}.
        slots:
          org_id: path.org_id
      - text: Show opportunity status changes for user {user_id} in organization {org_id}.
        slots:
          org_id: path.org_id
          user_id: query.user_id
      method: generated
      generated: '2026-09-26'