# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluent Cloud Metrics Version 2 API
  version: 1.0.0
extends: openapi/confluent-version-2-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v2/metrics/{dataset}/descriptors/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List the metrics available in a dataset
      effect: read
      questions:
      - Which metrics can I query in the Confluent Cloud metrics dataset?
      - What labels and data type does each available metric have?
      - Can I see only the metrics that apply to one resource type, like Kafka clusters?
      instructions:
      - text: List every metric descriptor in the {dataset} dataset.
        slots:
          dataset: path.dataset
      - text: Show the metric names and labels in {dataset} that apply to {resource_type} resources.
        slots:
          dataset: path.dataset
          resource_type: query.resource_type
      - text: Fetch the next page of metric descriptors for {dataset} using token {page_token}.
        slots:
          dataset: path.dataset
          page_token: query.page_token
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v2/metrics/{dataset}/descriptors/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List the resource types a dataset has metrics for
      effect: read
      questions:
      - What kinds of resources does a metrics dataset report on?
      - Which resource types and their labels are described in the cloud dataset?
      instructions:
      - text: List the resource descriptors in the {dataset} dataset.
        slots:
          dataset: path.dataset
      - text: Show up to {page_size} resource types described in {dataset}.
        slots:
          dataset: path.dataset
          page_size: query.page_size
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v2/metrics/{dataset}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query time-series metric values
      effect: read
      questions:
      - How do I get hourly bytes received for my Kafka cluster over the last day?
      - Can I group metric results by topic and keep only the top groups?
      - What time granularities can a metrics query be bucketed into?
      instructions:
      - text: Query {aggregations} in {dataset} at {granularity} granularity over {intervals}.
        slots:
          aggregations: requestBody.aggregations
          dataset: path.dataset
          granularity: requestBody.granularity
          intervals: requestBody.intervals
      - text: Get {aggregations} values over {intervals} at {granularity}, grouped by {group_by}, from {dataset}.
        slots:
          aggregations: requestBody.aggregations
          intervals: requestBody.intervals
          granularity: requestBody.granularity
          group_by: requestBody.group_by
          dataset: path.dataset
      - text: Pull the time series for {aggregations} in {dataset} over {intervals} at {granularity}, filtered by {filter}.
        slots:
          aggregations: requestBody.aggregations
          dataset: path.dataset
          intervals: requestBody.intervals
          granularity: requestBody.granularity
          filter: requestBody.filter
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v2/metrics/{dataset}/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export current metrics for Prometheus scraping
      effect: read
      questions:
      - How can I scrape Confluent Cloud metrics into Prometheus or another OpenMetrics tool?
      - Can I export current metrics for just one Kafka cluster or connector?
      - Is it possible to skip metrics that failed instead of failing the whole export?
      instructions:
      - text: Export the current {dataset} metric values for Kafka cluster {kafka_id} in OpenMetrics format.
        slots:
          dataset: path.dataset
          kafka_id: query.resource.kafka.id
      - text: Export only the {metric} metric for connector {connector_id} from {dataset}.
        slots:
          metric: query.metric
          connector_id: query.resource.connector.id
          dataset: path.dataset
      - text: Export current metrics for Flink compute pool {compute_pool_id} from {dataset}, with ignore_failed_metrics set to {ignore_failed}.
        slots:
          compute_pool_id: query.resource.compute_pool.id
          dataset: path.dataset
          ignore_failed: query.ignore_failed_metrics
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v2/metrics/{dataset}/attributes'].post
  update:
    x-apievangelist-phrasing:
      intent: Enumerate the label values for a metric
      effect: read
      questions:
      - Which topic names currently show up as label values for a metric?
      - How do I find all the distinct values a metric label takes in a time range?
      instructions:
      - text: List the distinct {group_by} label values in {dataset}.
        slots:
          group_by: requestBody.group_by
          dataset: path.dataset
      - text: Enumerate the {group_by} values seen for metric {metric} in {dataset} during {intervals}.
        slots:
          group_by: requestBody.group_by
          metric: requestBody.metric
          dataset: path.dataset
          intervals: requestBody.intervals
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v2/metrics/{dataset}/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Discover Prometheus scrape targets
      effect: read
      questions:
      - Can Prometheus automatically discover which of my Confluent Cloud resources to scrape?
      - Which resources are scrape targets in a given environment?
      - How do I get discovery targets for a Kafka cluster and everything associated with it?
      instructions:
      - text: Get the Prometheus service discovery targets for {dataset}.
        slots:
          dataset: path.dataset
      - text: Discover scrape targets in {dataset} for environment {env}.
        slots:
          dataset: path.dataset
          env: query.env
      - text: Find {resource_type} scrape targets in {dataset} associated with Kafka cluster {kafka_id}.
        slots:
          resource_type: query.resource_type
          dataset: path.dataset
          kafka_id: query.associated_kafka_id
      method: generated
      generated: '2026-10-02'