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

Get /api/metrics/dashboard/schema

GET
/api/metrics/dashboard/schema

Auto-generated from router.go. Handler: GetDashboardSchema.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful response

Get /api/metrics/dashboard/schema.

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/metrics/dashboard/schema 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
dashboard_id
required
string
title
required
string
version
required
string
sections
required
Array<object>
object
id
required
string
title
required
string
description
required
string
panels
required
Array<object>
object
panel_id
required
string
title
required
string
type
required
string
category
required
string
metric_id
required
string
api_endpoint
required
string
visualization
required
object
chart_type
required
string
unit
string
decimals
integer
thresholds
Array<object>
object
value
required
number
color
required
string
Allowed values: #FF9800 #4CAF50 #2196F3 #F44336
min
integer
max
integer
show_legend
required
boolean
line_width
integer
legend_position
string
fill
integer
stacked
boolean
description
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