Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Reporting API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/campaign-values-reports'].post
$.paths['/api/flow-values-reports'].post
$.paths['/api/flow-series-reports'].post
$.paths['/api/form-values-reports'].post
$.paths['/api/form-series-reports'].post
$.paths['/api/segment-values-reports'].post
$.paths['/api/segment-series-reports'].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 Klaviyo Reporting API
  version: 1.0.0
extends: openapi/klaviyo-reporting-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: 7
- target: $.paths['/api/campaign-values-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report campaign performance totals
      effect: read
      questions:
      - What were the open and click rates for my campaigns last month?
      - Can I pull aggregate conversion numbers per campaign?
      instructions:
      - text: Get campaign performance values for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Report campaign opens, clicks and conversions using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-values-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report flow performance totals
      effect: read
      questions:
      - How much revenue did my welcome flow drive overall?
      - Can I get total click and open rates per flow for a timeframe?
      instructions:
      - text: Get flow performance totals for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Report aggregate flow statistics over a timeframe using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/flow-series-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report flow performance over time
      effect: read
      questions:
      - How has my abandoned cart flow performed day by day?
      - Can I chart flow statistics as a time series?
      instructions:
      - text: Get a daily flow performance series for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Chart flow statistics over time using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/form-values-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report signup form performance totals
      effect: read
      questions:
      - What's the overall submit rate of my signup forms?
      - Can I get total views and submissions for a form in a date range?
      instructions:
      - text: Get form performance totals for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Report aggregate form views and submissions using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/form-series-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report signup form performance over time
      effect: read
      questions:
      - How have my popup form submissions trended week over week?
      - Can I chart form statistics as a time series?
      instructions:
      - text: Get a form performance series for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Chart form submissions over time using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segment-values-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report segment membership totals
      effect: read
      questions:
      - How many members did a segment gain or lose in a period?
      - Can I get aggregate segment growth numbers?
      instructions:
      - text: Get segment membership totals for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Report overall segment growth using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/segment-series-reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Report segment membership over time
      effect: read
      questions:
      - How has a segment's size changed day by day?
      - Can I chart segment membership as a time series?
      instructions:
      - text: Get a segment membership series for {report_query}.
        slots:
          report_query: requestBody.data
      - text: Chart segment size over time using {report_query}.
        slots:
          report_query: requestBody.data
      method: generated
      generated: '2026-09-26'