# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity Stats API
  version: 1.0.0
extends: openapi/cohesity-stats-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: 17
- target: $.paths['/public/stats/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics on active alerts
      effect: read
      questions:
      - How many active alerts did my cluster raise over the past week?
      - Can I get active alert statistics for a specific time interval?
      instructions:
      - text: Compute active alert stats between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      - text: Give me active alert statistics from {startTimeUsecs} to {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get storage consumption by consumer
      effect: read
      questions:
      - Which protection jobs or views are consuming the most storage?
      - Can I break down storage consumers by storage domain or tenant?
      instructions:
      - text: Show storage stats for consumers of type {consumerType}.
        slots:
          consumerType: query.consumerType
      - text: List consumer stats in storage domains {viewBoxesIdList}, including the protection policy {fetchProtectionPolicy}.
        slots:
          viewBoxesIdList: query.viewBoxesIdList
          fetchProtectionPolicy: query.fetchProtectionPolicy
      - text: Get the top {maxCount} consumers for tenants {tenantIds}.
        slots:
          maxCount: query.maxCount
          tenantIds: query.tenantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/files'].get
  update:
    x-apievangelist-phrasing:
      intent: Get file distribution statistics
      effect: read
      questions:
      - What does the file size and type distribution look like on my cluster?
      - Can I see file distribution for a single storage domain instead of the whole cluster?
      instructions:
      - text: Compute file distribution stats for entity type {entityType}.
        slots:
          entityType: query.entityType
      - text: Show how files are distributed on the {entityType}.
        slots:
          entityType: query.entityType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/protectionRuns'].get
  update:
    x-apievangelist-phrasing:
      intent: Count protection runs by status (v1 public)
      effect: read
      questions:
      - How many protection runs failed in a given window, using the older public stats endpoint?
      - Can the v1 public stats API count runs that have a specific status?
      instructions:
      - text: Using the v1 public stats, count protection runs with status {status} from {startTimeUsecs} to {endTimeUsecs}.
        slots:
          status: query.status
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      - text: Get the legacy public protection run count for status {status} between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          status: query.status
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/protectionRuns/lastRun'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stats on each job's last protection run
      effect: read
      questions:
      - How did the most recent run of every protection job go?
      - Which jobs' last backup run failed?
      instructions:
      - text: Show stats for the last protection run of every job.
      - text: Summarize each job's latest run outcome.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/protectionSummary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize protected objects on the cluster
      effect: read
      questions:
      - How many objects on my cluster are protected versus unprotected?
      - Can I leave certain environment types out of the protected objects summary?
      instructions:
      - text: Give me the protected objects summary.
      - text: Summarize protected objects excluding types {excludeTypes}.
        slots:
          excludeTypes: query.excludeTypes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/restores'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics on restore tasks
      effect: read
      questions:
      - How many restores ran on my cluster this month?
      - Can I see restore task statistics for a chosen time range?
      instructions:
      - text: Compute restore task stats from {startTimeUsecs} to {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      - text: Show restore activity between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/storage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cluster storage statistics
      effect: read
      questions:
      - How much storage capacity is used and free on my cluster?
      - What are the overall storage stats for the cluster?
      instructions:
      - text: Show the cluster's storage stats.
      - text: Report storage usage and capacity for the cluster.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/tenants'].get
  update:
    x-apievangelist-phrasing:
      intent: Get storage statistics per tenant
      effect: read
      questions:
      - How much storage does each organization (tenant) use?
      - Can I get tenant usage stats in CSV format?
      instructions:
      - text: Show storage stats grouped by tenant.
      - text: Get tenant stats for organizations {organizationsIdList} in format {outputFormat}.
        slots:
          organizationsIdList: query.organizationsIdList
          outputFormat: query.outputFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/vaults'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics on vaults
      effect: read
      questions:
      - How much data is stored on my external vaults?
      - What are the overall vault statistics?
      instructions:
      - text: Show vault statistics.
      - text: Summarize usage across all vaults.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/vaults/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get entity size and count on vaults by provider
      effect: read
      questions:
      - How many entities and how much data have archival or cloud-spin runs put on each vault provider?
      - Can I see vault provider stats for one run type?
      instructions:
      - text: Compute size and count of entities on vaults for run type {runType}.
        slots:
          runType: query.runType
      - text: Break down vault provider usage for {runType} runs.
        slots:
          runType: query.runType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/vaults/runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Trend protection runs to or from vaults
      effect: read
      questions:
      - What's the trend of archival runs to my vault over the last month?
      - Can I bucket vault run stats by day or week?
      instructions:
      - text: Show a {interval} trend of {runType} vault runs from {startTimeUsecs} to {endTimeUsecs}.
        slots:
          interval: query.interval
          runType: query.runType
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      - text: Chart {runType} runs to vaults per {interval} between {startTimeUsecs} and {endTimeUsecs}.
        slots:
          runType: query.runType
          interval: query.interval
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/viewBoxes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get storage domain (view box) statistics
      effect: read
      questions:
      - How much space is each storage domain using?
      - Can I get stats for just a few storage domains?
      instructions:
      - text: Show stats for all storage domains.
      - text: Get storage domain stats for view boxes {viewBoxesIdList}.
        slots:
          viewBoxesIdList: query.viewBoxesIdList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/views'].get
  update:
    x-apievangelist-phrasing:
      intent: Get statistics on Views
      effect: read
      questions:
      - Which Views are the largest on my cluster?
      - Can I rank the top Views by a chosen metric?
      instructions:
      - text: Show View statistics.
      - text: List the top {numTopViews} Views by {metric}.
        slots:
          numTopViews: query.numTopViews
          metric: query.metric
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/stats/views/protocols'].get
  update:
    x-apievangelist-phrasing:
      intent: Get protocol usage stats for Views
      effect: read
      questions:
      - How many Views use NFS versus SMB or S3?
      - What's the protocol breakdown across my Views?
      instructions:
      - text: Show protocol statistics for Views.
      - text: Break down Views by access protocol.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats/protection-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get protection run statistics (v2)
      effect: read
      questions:
      - What are the protection run statistics from the newer v2 stats endpoint?
      - Can I filter v2 protection run stats by run status, without a required time window?
      instructions:
      - text: Get v2 protection run statistics.
      - text: Show v2 protection run stats with run status {runStatus} from {startTimeUsecs} to {endTimeUsecs}.
        slots:
          runStatus: query.runStatus
          startTimeUsecs: query.startTimeUsecs
          endTimeUsecs: query.endTimeUsecs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/stats'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch DR plan, site and application stats
      effect: read
      questions:
      - How can I power a custom dashboard with stats on my DR plans, sites and applications?
      - Can I get site connectivity statistics for disaster recovery?
      instructions:
      - text: Fetch detailed DR stats of types {statTypes}.
        slots:
          statTypes: requestBody.statTypes
      - text: Get site connectivity stats using {siteConnectivityStatsParams}.
        slots:
          siteConnectivityStatsParams: requestBody.siteConnectivityStatsParams
      - text: Pull DR activity stats with parameters {activityStatsParams}.
        slots:
          activityStatsParams: requestBody.activityStatsParams
      method: generated
      generated: '2026-10-01'