# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klaviyo Metrics API
  version: 1.0.0
extends: openapi/klaviyo-metrics-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: 24
- target: $.paths['/api/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List metrics in the account
      effect: read
      questions:
      - What metrics (event types) are being tracked in my Klaviyo account?
      - Can I filter metrics by integration name or category?
      instructions:
      - text: List all metrics in my account.
      - text: Show metrics from the integration matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metric by ID
      effect: read
      questions:
      - How do I look up the details of a single metric like Placed Order?
      - Which integration does a specific metric come from?
      instructions:
      - text: Get metric {metric_id}.
        slots:
          metric_id: path.id
      - text: Show metric {metric_id} with its {include}.
        slots:
          metric_id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metric-properties/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one metric property by ID
      effect: read
      questions:
      - How do I inspect a single property recorded on a metric's events?
      - Can I see sample values for one metric property?
      instructions:
      - text: Get metric property {property_id}.
        slots:
          property_id: path.id
      - text: Show metric property {property_id} with extra fields {additional_fields}.
        slots:
          property_id: path.id
          additional_fields: query.additional-fields[metric-property]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom metrics
      effect: read
      questions:
      - Which custom metrics have I defined in my account?
      - Can I see the underlying metrics each custom metric combines?
      instructions:
      - text: List all my custom metrics.
      - text: Show custom metrics including their {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom metric
      effect: write
      questions:
      - How do I define a custom metric that combines several events into one?
      - What fields does a new custom metric need?
      instructions:
      - text: Create a custom metric with name and definition {custom_metric}.
        slots:
          custom_metric: requestBody.data
      - text: Define a new custom metric that rolls up {custom_metric}.
        slots:
          custom_metric: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom metric
      effect: read
      questions:
      - How is a specific custom metric defined?
      - Can I fetch one custom metric by its ID?
      instructions:
      - text: Get custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      - text: Show the definition of custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom metric
      effect: destructive
      questions:
      - How do I get rid of a custom metric I no longer use?
      - Can I remove a custom metric by its ID?
      instructions:
      - text: Delete custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      - text: Remove the unused custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom metric
      effect: write
      questions:
      - Can I change which events a custom metric is built from?
      - How do I rename an existing custom metric?
      instructions:
      - text: Update custom metric {custom_metric_id} with {changes}.
        slots:
          custom_metric_id: path.id
          changes: requestBody.data
      - text: Change the definition of custom metric {custom_metric_id} to {changes}.
        slots:
          custom_metric_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List mapped metrics
      effect: read
      questions:
      - Which metrics are mapped to things like revenue in my account?
      - Can I see the metric or custom metric each mapping points to?
      instructions:
      - text: List all mapped metrics.
      - text: Show mapped metrics along with their {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one mapped metric
      effect: read
      questions:
      - What is a particular mapped metric currently pointing at?
      - Can I look up one mapped metric by its ID?
      instructions:
      - text: Get mapped metric {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      - text: Show mapping {mapped_metric_id} with its {include}.
        slots:
          mapped_metric_id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Remap a mapped metric
      effect: write
      questions:
      - How do I change which metric counts toward a mapped metric like revenue?
      - Can I point a mapped metric at a custom metric instead?
      instructions:
      - text: Update mapped metric {mapped_metric_id} to {mapping}.
        slots:
          mapped_metric_id: path.id
          mapping: requestBody.data
      - text: Point mapping {mapped_metric_id} at the metric in {mapping}.
        slots:
          mapped_metric_id: path.id
          mapping: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metric-aggregates'].post
  update:
    x-apievangelist-phrasing:
      intent: Aggregate event data for a metric
      effect: read
      questions:
      - How much revenue did Placed Order events generate per day last month?
      - Can I count a metric's events grouped by a property over a date range?
      - How do I build a report of unique opens over time?
      instructions:
      - text: 'Aggregate metric events with this query: {query}.'
        slots:
          query: requestBody.data
      - text: Sum and count events for the metric and date range in {query}, grouped by day.
        slots:
          query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metrics/{id}/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List flows triggered by a metric
      effect: read
      questions:
      - Which flows start when a given metric's event happens?
      - Can I see full flow records for everything a metric triggers?
      instructions:
      - text: List flows triggered by metric {metric_id}.
        slots:
          metric_id: path.id
      - text: Show full flow details for automations started by metric {metric_id}.
        slots:
          metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metrics/{id}/relationships/flow-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get IDs of flows a metric triggers
      effect: read
      questions:
      - Can I get only the flow IDs that use a metric as their trigger?
      - What flow-trigger relationships does a metric have?
      instructions:
      - text: Get just the flow IDs triggered by metric {metric_id}.
        slots:
          metric_id: path.id
      - text: Return flow-trigger relationships of metric {metric_id}.
        slots:
          metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metrics/{id}/metric-properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a metric's properties
      effect: read
      questions:
      - What properties are recorded on a metric's events?
      - Can I see full details of every property on a metric?
      instructions:
      - text: List the properties recorded for metric {metric_id}.
        slots:
          metric_id: path.id
      - text: Show all event properties on metric {metric_id} with {additional_fields}.
        slots:
          metric_id: path.id
          additional_fields: query.additional-fields[metric-property]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metrics/{id}/relationships/metric-properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get property IDs for a metric
      effect: read
      questions:
      - Can I fetch only the property IDs attached to a metric?
      - What metric-property relationships exist for one metric?
      instructions:
      - text: Get just the property IDs for metric {metric_id}.
        slots:
          metric_id: path.id
      - text: Return metric-property relationships of metric {metric_id}.
        slots:
          metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metric-properties/{id}/metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the metric a property belongs to
      effect: read
      questions:
      - Which metric does a given metric property belong to?
      - Can I get the full parent metric from a property ID?
      instructions:
      - text: Get the metric that property {property_id} belongs to.
        slots:
          property_id: path.id
      - text: Show the full parent metric of property {property_id}.
        slots:
          property_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/metric-properties/{id}/relationships/metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the metric ID for a property
      effect: read
      questions:
      - Can I get only the parent metric ID for a metric property?
      - What metric relationship does a property carry?
      instructions:
      - text: Get just the metric ID for property {property_id}.
        slots:
          property_id: path.id
      - text: Return the metric relationship of property {property_id}.
        slots:
          property_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics/{id}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List metrics inside a custom metric
      effect: read
      questions:
      - Which underlying metrics make up a custom metric?
      - Can I see full metric records for everything a custom metric combines?
      instructions:
      - text: List the metrics that custom metric {custom_metric_id} combines.
        slots:
          custom_metric_id: path.id
      - text: Show full metric details inside custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/custom-metrics/{id}/relationships/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metric IDs inside a custom metric
      effect: read
      questions:
      - Can I get only the IDs of metrics a custom metric is built from?
      - What metric relationships does a custom metric have?
      instructions:
      - text: Get just the metric IDs for custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      - text: Return metric relationships of custom metric {custom_metric_id}.
        slots:
          custom_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}/metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the metric behind a mapped metric
      effect: read
      questions:
      - Which standard metric does a mapped metric point to, if any?
      - Can I get the full metric record from a mapping?
      instructions:
      - text: Get the metric mapped by {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      - text: Show full details of the standard metric behind mapping {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}/relationships/metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the metric ID for a mapped metric
      effect: read
      questions:
      - Can I fetch only the metric ID a mapped metric points to?
      - What metric relationship does a mapping hold?
      instructions:
      - text: Get just the metric ID for mapped metric {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      - text: Return the metric relationship of mapping {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}/custom-metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom metric behind a mapping
      effect: read
      questions:
      - Is a mapped metric using a custom metric, and which one?
      - Can I read the custom metric definition a revenue mapping relies on?
      instructions:
      - text: Get the custom metric used by mapped metric {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      - text: Show the full custom metric definition behind mapping {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/mapped-metrics/{id}/relationships/custom-metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the custom metric ID for a mapping
      effect: read
      questions:
      - Can I get only the custom metric ID that a mapped metric uses?
      - Is there a custom-metric relationship ID stored on this mapping?
      instructions:
      - text: Look up which custom metric ID mapping {mapped_metric_id} uses.
        slots:
          mapped_metric_id: path.id
      - text: Return the custom-metric relationship on mapped metric {mapped_metric_id}.
        slots:
          mapped_metric_id: path.id
      method: generated
      generated: '2026-09-26'