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

Returns paginated weekly traffic snapshots ordered by week (newest first)

GET
/api/weekly-report/snapshots

Auto-generated from server.go. Handler: s.getWeeklySnapshots.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Returns paginated weekly traffic snapshots ordered by week (newest first).

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

object
data
required
Array<object>
object
week_start
required
string format: date-time
week_end
required
string format: date-time
created_at
required
string format: date-time
total_incoming
required
integer
total_accepted
required
integer
total_blocked
required
integer
filter_percentage
required
number
v4_discover
required
integer
v4_offer
required
integer
v4_request
required
integer
v4_ack
required
integer
v4_nak
required
integer
v4_decline
required
integer
v4_release
required
integer
v4_inform
required
integer
v6_solicit
required
integer
v6_advertise
required
integer
v6_request
required
integer
v6_reply
required
integer
v6_confirm
required
integer
v6_renew
required
integer
v6_rebind
required
integer
v6_release
required
integer
v6_decline
required
integer
v6_reconfigure
required
integer
v6_info_request
required
integer
v6_relay_forw
required
integer
v6_relay_repl
required
integer
v4_discover_blocked
required
integer
v4_offer_blocked
required
integer
v4_request_blocked
required
integer
v4_ack_blocked
required
integer
v4_nak_blocked
required
integer
v4_decline_blocked
required
integer
v4_release_blocked
required
integer
v4_inform_blocked
required
integer
v6_solicit_blocked
required
integer
v6_advertise_blocked
required
integer
v6_request_blocked
required
integer
v6_reply_blocked
required
integer
v6_confirm_blocked
required
integer
v6_renew_blocked
required
integer
v6_rebind_blocked
required
integer
v6_release_blocked
required
integer
v6_decline_blocked
required
integer
v6_reconfigure_blocked
required
integer
v6_info_request_blocked
required
integer
v6_relay_forw_blocked
required
integer
v6_relay_repl_blocked
required
integer
daily_avg_unique_macs
required
number
top_blocked_macs_count
required
integer
total_v4_packets
required
integer
total_v6_packets
required
integer
metadata
required
object
execution_time_ms
required
integer
limit
required
integer
offset
required
integer
total
required
integer
status
required
string

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