# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Optimizely Reports API
  version: 1.0.0
extends: openapi/optimizely-reports-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: 7
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiment reports in an environment
      effect: read
      questions:
      - Which reports exist in a given project environment?
      - Can I include archived reports or search reports by name?
      - How do I page through a long list of reports?
      instructions:
      - text: List reports in environment {environment_key} of project {project_id}.
        slots:
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Search reports in project {project_id}, environment {environment_key}, for {query}.
        slots:
          project_id: path.project_id
          environment_key: path.environment_key
          query: query.query
      - text: List archived reports in {environment_key} for project {project_id}, archived set to {archived}.
        slots:
          environment_key: path.environment_key
          project_id: path.project_id
          archived: query.archived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports/archived'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive reports
      effect: write
      questions:
      - Can I hide old reports without permanently deleting them?
      - Is there a way to archive several reports at once?
      instructions:
      - text: Archive reports {keys} in environment {environment_key} of project {project_id}.
        slots:
          keys: requestBody.keys
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Move reports {keys} in project {project_id} ({environment_key}) to the archive.
        slots:
          keys: requestBody.keys
          project_id: path.project_id
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports/unarchived'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore archived reports
      effect: write
      questions:
      - How do I bring an archived report back into the active list?
      - Can I unarchive several reports in one call?
      instructions:
      - text: Unarchive reports {keys} in environment {environment_key} of project {project_id}.
        slots:
          keys: requestBody.keys
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Restore archived reports {keys} for project {project_id} in {environment_key}.
        slots:
          keys: requestBody.keys
          project_id: path.project_id
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports/{report_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single report
      effect: read
      questions:
      - Can I open one report by its key in a specific environment?
      - What does a single report record contain?
      instructions:
      - text: Fetch report {report_key} in environment {environment_key} of project {project_id}.
        slots:
          report_key: path.report_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Show report {report_key} from project {project_id}, {environment_key}.
        slots:
          report_key: path.report_key
          project_id: path.project_id
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports/{report_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a report
      effect: destructive
      questions:
      - Is deleting a report permanent, or can I get the data back?
      - How do I remove a report for good instead of archiving it?
      instructions:
      - text: Permanently delete report {report_key} in environment {environment_key} of project {project_id}.
        slots:
          report_key: path.report_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Delete report {report_key} from project {project_id} ({environment_key}) for good.
        slots:
          report_key: path.report_key
          project_id: path.project_id
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project_id}/environments/{environment_key}/reports/{report_key}/reset-results'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a report's results
      effect: destructive
      questions:
      - Can I clear a report's results and start counting from now?
      - What happens to previous results when I reset a report?
      instructions:
      - text: Reset the results of report {report_key} in environment {environment_key} of project {project_id}.
        slots:
          report_key: path.report_key
          environment_key: path.environment_key
          project_id: path.project_id
      - text: Wipe report {report_key}'s results in project {project_id}, {environment_key}, and restart calculation.
        slots:
          report_key: path.report_key
          project_id: path.project_id
          environment_key: path.environment_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/experiments/{experiment_id}/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experiment's results report
      effect: read
      questions:
      - Did my experiment's variations reach statistical significance?
      - Can I break experiment results down by device or browser for a date range?
      - Which baseline variation can I compare the results against?
      instructions:
      - text: Get the results report for experiment {experiment_id}.
        slots:
          experiment_id: path.experiment_id
      - text: Show experiment {experiment_id} results from {start_time} to {end_time} on device {device}.
        slots:
          experiment_id: path.experiment_id
          start_time: query.start_time
          end_time: query.end_time
          device: query.device
      - text: Compare experiment {experiment_id} against baseline variation {baseline_variation_id}.
        slots:
          experiment_id: path.experiment_id
          baseline_variation_id: query.baseline_variation_id
      method: generated
      generated: '2026-09-26'