SendPulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for SendPulse Pop-up Popup statistic API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/public/api/statistics/popup/{popupId}'].get
$.paths['/public/api/statistics/nps/{popupId}'].get
$.paths['/public/api/statistics/nps/{popupId}/aggregated'].get

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 SendPulse Pop-up Popup statistic API
  version: 1.0.0
extends: openapi/sendpulse-popup-statistic-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: 3
- target: $.paths['/public/api/statistics/popup/{popupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get views and interactions for a pop-up
      effect: read
      questions:
      - How many visitors saw and interacted with my pop-up?
      - Can I get pop-up performance for a date range?
      instructions:
      - text: Show statistics for pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Get views and interactions for pop-up {popupId} from {start} to {end}.
        slots:
          popupId: path.popupId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/statistics/nps/{popupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get vote counts per NPS option
      effect: read
      questions:
      - How many votes did each NPS score button get?
      - Can I see the per-variant breakdown of my NPS survey pop-up?
      instructions:
      - text: Show the votes per NPS variant for pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Break down NPS button votes for pop-up {popupId} between {start} and {end}.
        slots:
          popupId: path.popupId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/api/statistics/nps/{popupId}/aggregated'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the aggregated NPS result for a pop-up
      effect: read
      questions:
      - What is the overall Net Promoter Score from my survey pop-up?
      - Can I get the summary NPS result for a period?
      instructions:
      - text: Get the aggregated NPS score for pop-up {popupId}.
        slots:
          popupId: path.popupId
      - text: Summarize the NPS result of pop-up {popupId} from {start} to {end}.
        slots:
          popupId: path.popupId
          start: query.start
          end: query.end
      method: generated
      generated: '2026-10-01'