Palo Alto Networks · JSON Structure

Dns Security Api Network Stats Structure

NetworkStats schema from Palo Alto Networks DNS Security API

Type: object Properties: 8
Cloud SecurityCybersecurityFirewallNetwork SecuritySASESOARThreat IntelligenceXDR

NetworkStats is a JSON Structure definition published by Palo Alto Networks, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

customerid period total_queries blocked_queries allowed_queries sinkholed_queries top_queried_domains category_breakdown

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/json-structure/dns-security-api-network-stats-structure.json",
  "name": "NetworkStats",
  "description": "NetworkStats schema from Palo Alto Networks DNS Security API",
  "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": "int32",
      "description": "Total DNS queries processed during the period."
    },
    "blocked_queries": {
      "type": "int32",
      "description": "DNS queries blocked by DNS Security policy."
    },
    "allowed_queries": {
      "type": "int32",
      "description": "DNS queries allowed by DNS Security policy."
    },
    "sinkholed_queries": {
      "type": "int32",
      "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": "int32"
          },
          "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": "int32"
          },
          "percentage": {
            "type": "float"
          }
        }
      }
    }
  }
}