Customer.io · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Customer.io App Newsletter Metrics API

6 actions 6 updates phrasing extends openapi/customer-io-newsletter-metrics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Customer.io's API. It is a proposal applied on top of the contract, not a document Customer.io publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/newsletters/{newsletter_id}/metrics'].get

$.paths['/v1/newsletters/{newsletter_id}/metrics/links'].get

$.paths['/v1/newsletters/{newsletter_id}/messages'].get

$.paths['/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics'].get

$.paths['/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics/links'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Customer.io App Newsletter Metrics API
  version: 1.0.0
extends: openapi/customer-io-newsletter-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: 5
- target: $.paths['/v1/newsletters/{newsletter_id}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get newsletter metrics over time
      effect: read
      questions:
      - How many opens and clicks did my newsletter get each day?
      - Can I see a newsletter's metrics in weekly steps?
      instructions:
      - text: Get metrics for newsletter {newsletter_id} by {period}.
        slots:
          newsletter_id: path.newsletter_id
          period: query.period
      - text: Show the last {steps} periods of metrics for newsletter {newsletter_id}.
        slots:
          steps: query.steps
          newsletter_id: path.newsletter_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/metrics/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link click metrics for a newsletter
      effect: read
      questions:
      - Which links in my newsletter were clicked the most?
      - Can I count unique clicks on newsletter links?
      instructions:
      - text: Show link click metrics for newsletter {newsletter_id}.
        slots:
          newsletter_id: path.newsletter_id
      - text: Get unique link clicks for newsletter {newsletter_id} by {period}.
        slots:
          newsletter_id: path.newsletter_id
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List deliveries sent by a newsletter
      effect: read
      questions:
      - Who received my newsletter and did they open it?
      - Can I list only the newsletter deliveries that bounced?
      instructions:
      - text: List deliveries for newsletter {newsletter_id}.
        slots:
          newsletter_id: path.newsletter_id
      - text: Show newsletter {newsletter_id} deliveries with metric {metric}.
        slots:
          newsletter_id: path.newsletter_id
          metric: query.metric
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for a newsletter variant
      effect: read
      questions:
      - How did variant B of my newsletter A/B test perform?
      - Can I see metrics for just the Spanish version of a newsletter?
      instructions:
      - text: Get metrics for variant {content_id} of newsletter {newsletter_id}.
        slots:
          content_id: path.content_id
          newsletter_id: path.newsletter_id
      - text: Show newsletter {newsletter_id} variant {content_id} metrics by {period}.
        slots:
          newsletter_id: path.newsletter_id
          content_id: path.content_id
          period: query.period
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/newsletters/{newsletter_id}/contents/{content_id}/metrics/links'].get
  update:
    x-apievangelist-phrasing:
      intent: Get link clicks for a newsletter variant
      effect: read
      questions:
      - Which links were clicked in one A/B test variant of my newsletter?
      - Can I compare link clicks between newsletter translations?
      instructions:
      - text: Show link clicks for variant {content_id} of newsletter {newsletter_id}.
        slots:
          content_id: path.content_id
          newsletter_id: path.newsletter_id
      - text: Get link metrics for newsletter {newsletter_id} variant {content_id} over {steps} periods.
        slots:
          newsletter_id: path.newsletter_id
          content_id: path.content_id
          steps: query.steps
      method: generated
      generated: '2026-09-26'