Analytics

Routes for Sign API analytics and logging.

Pips

GET/analytics/pips

Retrieve stats as an SVG

Query Parameters

labelColourstring= "#555"
valueColourstring= "#007ec6"
hoursnumber (double)= 1
clientenum

Logical "client name" recorded against each request — supplied by the caller via the metadata.client_name RPC field. Free-form on the wire, but conventionally one of the values below.

jsonboolean= false

Responses

200Ok

Response Attributes

code*number (double)
messagestring
image_url*string
label*string
value*number (double)
unit*string
||
Request
Response200

Get hosts

GET/analytics/hosts

Retrieve the list of API hosts (used for horizontal scaling)

Responses

200Ok

Response Attributes

code*number (double)
messagestring
hostsobject[]
||
Request
Response200

Fetch agents

GET/analytics/agents

Retrieve the currently connected agents

Responses

200All registered agents

Response Attributes

code*number (double)
messagestring
agents*object[]
||
Request
Response200