# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zendesk Audit Logs API
  version: 1.0.0
extends: openapi/zendesk-audit-logs-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/audit_logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit log entries
      effect: read
      questions:
      - Who changed settings in my account, and when?
      - Can I filter audit log entries by the actor or IP address?
      - Is it possible to see only audit events of a particular action type?
      instructions:
      - text: List audit log entries made by user {actor_id}.
        slots:
          actor_id: query.filter[actor_id]
      - text: Show audit logs from IP address {ip_address}.
        slots:
          ip_address: query.filter[ip_address]
      - text: List {action} audit events on {source_type} records created {created_at}.
        slots:
          action: query.filter[action]
          source_type: query.filter[source_type]
          created_at: query.filter[created_at]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/audit_logs/{audit_log_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show an audit log entry
      effect: read
      questions:
      - Can I view the full details of one audit log entry?
      - Which accounts can read an individual audit log record?
      instructions:
      - text: Show the audit log entry with that ID.
      - text: Fetch the details of one audit event.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/audit_logs/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export audit logs
      effect: read
      questions:
      - Can I export the audit log to a file for compliance review?
      - Does an audit log export accept the same filters as listing?
      instructions:
      - text: Export the audit logs for actor {actor_id}.
        slots:
          actor_id: query.filter[actor_id]
      - text: Export audit events created {created_at} for source {source_id}.
        slots:
          created_at: query.filter[created_at]
          source_id: query.filter[source_id]
      method: generated
      generated: '2026-09-26'