Get /api/metrics/clients/:mac/events

GET

/api/metrics/clients/{mac}/events

• Your DHCP Shield Pro appliance

Auto-generated from router.go. Handler: clientBehavior.GetClientEvents.

Authorizations

• bearerAuth

Parameters

Path Parameters

mac

required

string

/^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/

Example

aa:bb:cc:dd:ee:ff

Full MAC address with colon or hyphen separators.

Responses

200

Successful response

Get /api/metrics/clients/:mac/events.

Lifted by tools/schema-lift on 2026-05-16 from a live sample of GET /api/metrics/clients/{mac}/events 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

columns

required

Array<object>

object

field

required

string

header

required

string

type

required

string

rows

required

Array<object>

object

dst_ip

required

string format: ipv4

hostname

required

string

matched_rule

required

string

message_type

required

string

src_ip

required

string format: ipv4

timestamp

required

string format: date-time

vendor_class

required

string

xid

required

string

pagination

required

object

total

required

integer

page

required

integer

per_page

required

integer

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

query

required

object

Start

required

string format: date-time

End

required

string format: date-time

Step

required

string

Limit

required

integer

Aggregate

required

string

Format

required

string

Filters

required

string

ExcludeBlocked

required

boolean

Protocol

required

string

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

404

The requested resource was not found.

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

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