Palo Alto Networks · Schema

NetworkStats

NetworkStats schema from Palo Alto Networks DNS Security API

Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

Properties

Name Type Description
customerid string Customer ID for which statistics are returned.
period object
total_queries integer Total DNS queries processed during the period.
blocked_queries integer DNS queries blocked by DNS Security policy.
allowed_queries integer DNS queries allowed by DNS Security policy.
sinkholed_queries integer DNS queries redirected to sinkhole.
top_queried_domains array Most frequently queried domains during the period.
category_breakdown array Query counts grouped by DNS Security category.
View JSON Schema on GitHub

JSON Schema

dns-security-api-network-stats-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "NetworkStats",
  "description": "NetworkStats schema from Palo Alto Networks DNS Security API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-schema/dns-security-api-network-stats-schema.json",
  "type": "object",
  "properties": {
    "customerid": {
      "type": "string",
      "description": "Customer ID for which statistics are returned."
    },
    "period": {
      "type": "object",
      "properties": {
        "start": {
          "type": "string",
          "description": "Start of the statistics period."
        },
        "end": {
          "type": "string",
          "description": "End of the statistics period."
        }
      }
    },
    "total_queries": {
      "type": "integer",
      "description": "Total DNS queries processed during the period."
    },
    "blocked_queries": {
      "type": "integer",
      "description": "DNS queries blocked by DNS Security policy."
    },
    "allowed_queries": {
      "type": "integer",
      "description": "DNS queries allowed by DNS Security policy."
    },
    "sinkholed_queries": {
      "type": "integer",
      "description": "DNS queries redirected to sinkhole."
    },
    "top_queried_domains": {
      "type": "array",
      "description": "Most frequently queried domains during the period.",
      "items": {
        "type": "object",
        "properties": {
          "domain": {
            "type": "string"
          },
          "query_count": {
            "type": "integer"
          },
          "dns_security_category": {
            "type": "string"
          }
        }
      }
    },
    "category_breakdown": {
      "type": "array",
      "description": "Query counts grouped by DNS Security category.",
      "items": {
        "type": "object",
        "properties": {
          "category": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          },
          "percentage": {
            "type": "number",
            "format": "float"
          }
        }
      }
    }
  }
}