HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. aggregateStats

Get aggregated DNS statistics filtered by appliances and query parameters

post
http://127.0.0.1:8080/stats2/aggregate/dns

Retrieves aggregated DNS traffic statistics for specified appliances within a time range. Supports filtering by traffic direction, protocol type, and geographic grouping. Results include bandwidth metrics (LAN/WAN bytes and packets), flow counts, and domain information.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
required
≥ 0

Start time boundary for data range in seconds since EPOCH (Unix timestamp). Must be non-negative and less than endTime.

int64
required
≥ 0

End time boundary for data range in seconds since EPOCH (Unix timestamp). Must be greater than startTime.

integer
enum

Filter DNS records by traffic direction. 0 = destination traffic, 1 = source traffic.

Allowed:
integer
enum

Filter by protocol type. 0 = HTTP, 1 = HTTPS, 2 = unassigned, 3 = others.

Allowed:
integer
≥ 1

Maximum number of DNS records to return. Results ordered by total LAN bytes (LANRX + LANTX) descending.

boolean
Defaults to false

If true and no data found in specified time range, automatically queries one hour earlier. Useful for recent data lookups.

boolean

If true, results are grouped by appliance (nePk) with nested stats per appliance. Default is null (no split).

string
enum

Column name to group results by. Valid values: associd, timestamp, country, calc_dns, is_source, split_type, service_id, dns, ipaddr, flow_count, DOMAIN1, DOMAIN2, DOMAIN3, DOMAIN4. Use 'country' to group by geographic location.

integer
1 to 4
Defaults to 2

Number of sub-domain levels to include in grouping (1-4). Default is 2. Controls domain hierarchy depth in results.

Body Params

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Array of appliance-tunnel filter objects. Each entry specifies an appliance and optionally a tunnel to retrieve statistics for.

Identifies an appliance and optionally a specific tunnel for statistics retrieval.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string | null

Specific tunnel identifier to filter. If null or not provided, returns stats for all tunnels on the appliance (excluding 'all traffic' and 'optimized traffic').

string | null

Orchestrator tunnel ID. Required when isRemote is true to identify the remote tunnel.

boolean
Defaults to false

Indicates if querying for a remote tunnel. When true, orchTid must be provided. Stats are retrieved from peer appliances.

Responses

Updated about 14 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 14 hours ago

Did this page help you?