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

Returns all custom reports accessible to the current user (system + user's own)

GET
/api/reports

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

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Returns all custom reports accessible to the current user (system + user’s own).

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/reports 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
id
required
string
name
required
string
description
required
string
report_spec
required
object
group_by
required
string
metrics
required
Array<object>
object
function
required
string
Allowed values: count uniq
field
required
string
Allowed values: "" client_mac your_ip xid
alias
required
string
order_by
required
string
order_dir
required
string
limit
required
integer
filters
required
object
min_request_count
integer
message_types
Array<string>
has_active_action
boolean
action_types
Array<string>
time_range
required
object
type
required
string
value
required
string
Allowed values: 24h 7d
is_system
required
boolean
created_by
required
integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
run_count
required
integer
total
required
integer
page
required
integer
totalPages
required
integer

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