API section

Monitoring

Fleet state: the account summary in one request, alerts (fiscal drive, OFD, shift, register not answering, register gone), register events and the latest metric values across registers.

GET	`/api/v1/summary`	Account summary
GET	`/api/v1/metrics/latest`	Latest metric value per register
GET	`/api/v1/events`	Register events
GET	`/api/v1/alerts`	Register alerts

Account summary#

GET/api/v1/summary

How many registers are online, agent versions, open alerts by code, agent requests in the last day — the fleet state in one request

Response 200 application/json

Fields · Summary

devicesmap → integer int64
agentVersionsmap → integer int64
alertsmap → any value
requestsmap → integer int64

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/summary' \
  -H 'X-Api-Key: hwk_…'

Latest metric value per register#

GET/api/v1/metrics/latest

For example name=fn.days_left — days left on the fiscal drive of each account register; the value for the last 7 days, one per register and label set

Parameters

Name	In	Type	Description
`name`required	query	string	Metric name: fn.days_left, ofd.not_sent, shift.open, register.ok, agent.up…
`deviceId`	query	integer int64	Only this register

Response 200 application/json

Array · LatestMetric

deviceIdinteger int64
atstring date-time
namestring
valuenumber double
labelsstring

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/metrics/latest?name=fn.days_left' \
  -H 'X-Api-Key: hwk_…'

Register events#

GET/api/v1/events

Failed operations, printers, power, register not answering — newest first; total — in X-Total-Count

Parameters

Name	In	Type	Description
`deviceId`	query	integer int64	Only this register
`type`	query	string	Event type: operation.failed, printer, power, register.unavailable…
`since`	query	string date-time	Not earlier than this time (ISO 8601)
`limit`	query	integer int32
`offset`	query	integer int32

Response 200 application/json

Array · EventView

atstring date-time
typestring
payloadobject
deviceIdinteger int64

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/events' \
  -H 'X-Api-Key: hwk_…'

Register alerts#

GET/api/v1/alerts

FN_EXPIRING (fiscal drive ≤ 30 days, ≤ 7 — critical), OFD_BACKLOG, SHIFT_EXPIRED, REGISTER_UNAVAILABLE, DEVICE_OFFLINE. They open and close by themselves; open=false — closed ones too

Parameters

Name	In	Type	Description
`open`	query	boolean
`deviceId`	query	integer int64
`code`	query	string	Only this code: FN_EXPIRING, OFD_BACKLOG…
`severity`	query	string	WARNING or CRITICAL

Response 200 application/json

Array · Alert

idinteger int64
deviceIdinteger int64
codestring
subjectstring
severitystring
messagestring
valuenumber double
openedAtstring date-time
updatedAtstring date-time
closedAtstring date-time

Errors — problem+json with a code field, see error codes.

Request example

curl

curl 'https://cloud.hw-connector.ru/api/v1/alerts' \
  -H 'X-Api-Key: hwk_…'