Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Metric API

3 actions 3 updates phrasing extends openapi/lytics-metric-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lytics's API. It is a proposal applied on top of the contract, not a document Lytics publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/api/metric/'].get
$.paths['/api/metric'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for V1 Lytics Metric API
  version: 1.0.0
extends: openapi/lytics-metric-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: 2
- target: $.paths['/api/metric/'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch metrics using query parameters
      effect: read
      questions:
      - Can I fetch segment size metrics over time with a simple GET?
      - Can I choose the interval and date range of a metric?
      instructions:
      - text: Get metric {name} for dimension {dimension} {dimension_id} of type {dimension_type}.
        slots:
          name: query.name
          dimension: query.dimension
          dimension_id: query.dimension_id
          dimension_type: query.dimension_type
      - text: Fetch {dimension} {dimension_id} ({dimension_type}) metrics from {start_date} to {end_date}.
        slots:
          dimension: query.dimension
          dimension_id: query.dimension_id
          dimension_type: query.dimension_type
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/metric'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch metrics using a request body
      effect: read
      questions:
      - Can I request metrics by posting the arguments in a JSON body?
      - Can I smooth or aggregate metrics when posting the query?
      instructions:
      - text: Post a metrics request for dimension {dimension} {dimension_id}.
        slots:
          dimension: requestBody.dimension
          dimension_id: requestBody.dimension_id
      - text: Request {aggregation} metrics by {interval} in the body for {dimension_id}.
        slots:
          aggregation: requestBody.aggregation
          interval: requestBody.interval
          dimension_id: requestBody.dimension_id
      method: generated
      generated: '2026-10-01'