Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lytics Metrics API

3 actions 3 updates phrasing extends openapi/lytics-metrics-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['/metric'].get
$.paths['/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 Lytics Metrics API
  version: 1.0.0
extends: openapi/lytics-metrics-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: 2
- target: $.paths['/metric'].get
  update:
    x-apievangelist-phrasing:
      intent: Query a time-series metric
      effect: read
      questions:
      - How has a segment's size changed over the last month?
      - Can I get daily metric buckets for a stream between two dates?
      instructions:
      - text: Get metric {name} for {dimension_type} {dimension_id} aggregated by {aggregation}.
        slots:
          name: query.name
          dimension_type: query.dimension_type
          dimension_id: query.dimension_id
          aggregation: query.aggregation
      - text: Chart {dimension} for {dimension_type} {dimension_id} by {aggregation} from {start_date} to {end_date} every {interval}.
        slots:
          dimension: query.dimension
          dimension_type: query.dimension_type
          dimension_id: query.dimension_id
          aggregation: query.aggregation
          start_date: query.start_date
          end_date: query.end_date
          interval: query.interval
      method: generated
      generated: '2026-10-02'
- target: $.paths['/metric'].post
  update:
    x-apievangelist-phrasing:
      intent: Query several metrics in one request
      effect: read
      questions:
      - Can I request many metric series at once with a JSON array?
      - Is there a batch way to pull metrics for several segments and experiences together?
      instructions:
      - text: Run a batch of metric requests in one call.
      - text: Post several metric queries together for account {account_id}.
        slots:
          account_id: query.account_id
      method: generated
      generated: '2026-10-02'