Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Satisfaction Ratings API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/v2/satisfaction_ratings'].get
$.paths['/api/v2/satisfaction_ratings/{satisfaction_rating_id}'].get
$.paths['/api/v2/satisfaction_ratings/count'].get
$.paths['/api/v2/tickets/{ticket_id}/satisfaction_rating'].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 Zendesk Satisfaction Ratings API
  version: 1.0.0
extends: openapi/zendesk-satisfaction-ratings-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: 4
- target: $.paths['/api/v2/satisfaction_ratings'].get
  update:
    x-apievangelist-phrasing:
      intent: List satisfaction ratings
      effect: read
      questions:
      - Which customers left good or bad CSAT ratings?
      - Can I filter satisfaction ratings by score and time range?
      instructions:
      - text: List all satisfaction ratings.
      - text: Show bad satisfaction ratings from last month.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/satisfaction_ratings/{satisfaction_rating_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a satisfaction rating
      effect: read
      questions:
      - How do I look up one satisfaction rating by id?
      - Can I see the comment on a specific CSAT rating?
      instructions:
      - text: Show satisfaction rating {satisfaction_rating_id}.
        slots:
          satisfaction_rating_id: path.satisfaction_rating_id
      - text: Get the score and comment on rating {satisfaction_rating_id}.
        slots:
          satisfaction_rating_id: path.satisfaction_rating_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/satisfaction_ratings/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count satisfaction ratings
      effect: read
      questions:
      - How many satisfaction ratings are in my account?
      - Is the satisfaction rating count approximate?
      instructions:
      - text: Count satisfaction ratings.
      - text: Tell me the total number of CSAT ratings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/tickets/{ticket_id}/satisfaction_rating'].post
  update:
    x-apievangelist-phrasing:
      intent: Rate a solved ticket
      effect: write
      questions:
      - Can a requester rate a solved ticket through the API?
      - Which scores are valid when creating a satisfaction rating?
      instructions:
      - text: Rate ticket {ticket_id} as good.
        slots:
          ticket_id: path.ticket_id
      - text: Leave a bad satisfaction rating on ticket {ticket_id}.
        slots:
          ticket_id: path.ticket_id
      method: generated
      generated: '2026-09-26'