Zendesk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Zendesk Activities Activity Stream API

4 actions 4 updates phrasing extends openapi/zendesk-activity-stream-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 4

$.info

$.paths['/api/v2/activities'].get

$.paths['/api/v2/activities/{activity_id}'].get

$.paths['/api/v2/activities/count'].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 Zendesk Activities Activity Stream API
  version: 1.0.0
extends: openapi/zendesk-activity-stream-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/v2/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List my recent ticket activities
      effect: read
      questions:
      - What ticket activity has affected me in the last 30 days?
      - Can I see who acted on tickets that involve me recently?
      instructions:
      - text: List my ticket activities from the last month.
      - text: Show the recent activity stream for me.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/activities/{activity_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ticket activity
      effect: read
      questions:
      - Can I look at the details of one activity in my stream?
      - What does a single activity record contain?
      instructions:
      - text: Show this activity.
      - text: Get the details of that activity entry.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/activities/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count my recent ticket activities
      effect: read
      questions:
      - How many ticket activities affected me in the last 30 days?
      - Is the activity count cached when it's very large?
      instructions:
      - text: Count my activities from the last 30 days.
      - text: Give me the approximate number of my recent activities.
      method: generated
      generated: '2026-09-26'