Klaviyo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klaviyo Reviews API

4 actions 4 updates phrasing extends openapi/klaviyo-reviews-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 4

$.info
$.paths['/api/reviews'].get
$.paths['/api/reviews/{id}'].get
$.paths['/api/reviews/{id}'].patch

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 Reviews API
  version: 1.0.0
extends: openapi/klaviyo-reviews-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: 3
- target: $.paths['/api/reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List product reviews
      effect: read
      questions:
      - What reviews have customers left on my products?
      - Can I filter reviews by rating or status on the server side?
      instructions:
      - text: List reviews matching {filter}.
        slots:
          filter: query.filter
      - text: Show all reviews sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/reviews/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one review
      effect: read
      questions:
      - What does a specific review say?
      - Can I fetch a single review with its related event?
      instructions:
      - text: Get review {review_id}.
        slots:
          review_id: path.id
      - text: Show the full text and rating of review {review_id}.
        slots:
          review_id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/reviews/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a review
      effect: write
      questions:
      - Can I change the status of a review, for example to publish or reject it?
      - How do I update an existing review?
      instructions:
      - text: Update review {review_id} with {changes}.
        slots:
          review_id: path.id
          changes: requestBody.data
      - text: Change the moderation status of review {review_id} to {changes}.
        slots:
          review_id: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'