Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Ticket Metrics API

3 actions 3 updates phrasing extends openapi/zendesk-ticket-metrics-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 3

$.info
$.paths['/api/v2/ticket_metrics'].get
$.paths['/api/v2/ticket_metrics/{ticket_metric_id}'].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 Zendesk Ticket Metrics API
  version: 1.0.0
extends: openapi/zendesk-ticket-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: 2
- target: $.paths['/api/v2/ticket_metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List ticket metrics across tickets
      effect: read
      questions:
      - How do I pull reply times and resolution times for all our tickets?
      - Are archived tickets included when I list ticket metrics?
      instructions:
      - text: List ticket metrics for all tickets, newest first.
      - text: Export first reply and full resolution times across our tickets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/ticket_metrics/{ticket_metric_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for one ticket
      effect: read
      questions:
      - How long did it take us to first reply on a specific ticket?
      - Can I fetch the metrics of one ticket by metric id or ticket id?
      instructions:
      - text: Show ticket metrics {ticket_metric_id}.
        slots:
          ticket_metric_id: path.ticket_metric_id
      - text: Get reply and resolution times for metric record {ticket_metric_id}.
        slots:
          ticket_metric_id: path.ticket_metric_id
      method: generated
      generated: '2026-09-26'