Platform status¶

These schemas specify how the BigBoat status visualization is configured and how the data used by the visualization is formatted.

BigBoat status configuration¶

type	array
items	Duration specifier. Either full which indicates the entire range of collection data, or a positive number followed by a duration unit supported by Moment.js.
	type	string
	pattern	^full$\|^[0-9]+-(second\|minute\|hour\|day\|week\|month\|year)s?$

type	object
properties
_latest_date	Latest moment that data was collected across the entire organization.
	type	string
	oneOf	format	date
		format	date-time
patternProperties
^[A-Za-z ]+$	type	object
	properties
	titles	Localization titles for a subgraph of a BigBoat performance status field.
		BigBoat status field locale
	descriptions	Localization texts for a subgraph of a BigBoat performance status field.
		BigBoat status field locale
	unit	Units used by the BigBoat performance status field values.
		type	string
		enum	bytes, seconds

type	object
patternProperties
^[a-zA-Z]{2,3}(-.*)?$	Localization item for a specific language. Valid languages use two-letter ISO 639-1 language codes plus optional BCP 47 subtags, so only a subset of languages is recognized.
	type	string

type	array
items	BigBoat metric status

type	object
properties
name	Name of the metric.
	type	string
checked_date	Moment when the metric was measured.
	type	string
	pattern	^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9]$
ok	Whether the metric value is acceptable for a stable platform.
	type	boolean
value	Value of the metric.
	type	number
max	Maximum value that the metric can reach.
	type	number

type	object
patternProperties
.*	URL to the BigBoat instance for a project.
	type	string
	format	uri