Skip to content
Sign in Get started
DHCP Shield Pro DHCP Shield Pro

Get /api/metrics/firewall/traffic-flow-summary

GET
/api/metrics/firewall/traffic-flow-summary

Auto-generated from router.go. Handler: firewall.GetTrafficFlowSummary.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Get /api/metrics/firewall/traffic-flow-summary.

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/metrics/firewall/traffic-flow-summary against the demo. Required fields are conservative — server returned all of them in the seed; relax to optional if some states legitimately omit.

object
status
required
string
data
required
object
incoming_pps
required
number format: double
blocked_pps
required
number format: double
passed_pps
required
number format: double
filter_percentage
required
number format: double
message_breakdown
required
Array<object>
object
type
required
string
accepted
required
number format: double
dropped
required
number format: double
period_seconds
required
number format: double
metadata
required
object
data_points
required
integer
series_count
required
integer
execution_time_ms
required
integer
materialized_view_used
required
string
cache_hit
required
boolean

401

Section titled “401 ”

Authentication is required or the supplied token is invalid.

Standardised error envelope per RFC 7807. Many existing endpoints still return an older shape (e.g. {"error": "..."}). This schema documents the target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the spec describes current behaviour without enforcing the migration here.

object
type

A URI reference that identifies the problem type.

string format: uri-reference
default: about:blank
title

A short human-readable summary of the problem.

string
status

The HTTP status code generated by the origin server.

integer format: int32
>= 100 <= 599
detail

A human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri-reference
error

Legacy error message field. Will be removed once handlers are migrated.

string
details

Legacy per-field error details. Will be removed once handlers are migrated.

object
key
additional properties
string
requestId

The request id middleware-assigned identifier for tracing.

string

500

Section titled “500 ”

Internal server error

Standardised error envelope per RFC 7807. Many existing endpoints still return an older shape (e.g. {"error": "..."}). This schema documents the target shape; legacy endpoints will be migrated in Phase 70. Per D-21 the spec describes current behaviour without enforcing the migration here.

object
type

A URI reference that identifies the problem type.

string format: uri-reference
default: about:blank
title

A short human-readable summary of the problem.

string
status

The HTTP status code generated by the origin server.

integer format: int32
>= 100 <= 599
detail

A human-readable explanation specific to this occurrence.

string
instance

A URI reference that identifies the specific occurrence.

string format: uri-reference
error

Legacy error message field. Will be removed once handlers are migrated.

string
details

Legacy per-field error details. Will be removed once handlers are migrated.

object
key
additional properties
string
requestId

The request id middleware-assigned identifier for tracing.

string