Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare DNS DNS Analytics API

3 actions 3 updates phrasing extends openapi/cloudflare-dns-analytics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Cloudflare's API. It is a proposal applied on top of the contract, not a document Cloudflare publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/zones/{zone_id}/dns_analytics/report'].get
$.paths['/zones/{zone_id}/dns_analytics/report/bytime'].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 Cloudflare DNS DNS Analytics API
  version: 1.0.0
extends: openapi/cloudflare-dns-analytics-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['/zones/{zone_id}/dns_analytics/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated DNS query analytics for a zone
      effect: read
      questions:
      - How many DNS queries did my zone get in total?
      - Which response codes and record types show up most in my DNS traffic?
      instructions:
      - text: Get the aggregated DNS analytics report for zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: Summarize DNS query totals for {zone_id} from {since} to {until}.
        slots:
          zone_id: path.zone_id
          since: query.since
          until: query.until
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_analytics/report/bytime'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DNS analytics broken down over time
      effect: read
      questions:
      - How has my zone's DNS query volume changed hour by hour?
      - Can I group DNS analytics into time intervals?
      instructions:
      - text: Show DNS analytics for zone {zone_id} as a time series.
        slots:
          zone_id: path.zone_id
      - text: Chart DNS queries for {zone_id} from {since} to {until} in {time_delta} intervals.
        slots:
          zone_id: path.zone_id
          since: query.since
          until: query.until
          time_delta: query.time_delta
      method: generated
      generated: '2026-09-26'