dashboard.v1

key is the unique identifier. It will always be defined.

created_at represents the date the dashboard was first created.

Old dashboards may not have this field set.

created_by keeps the name of the user who first created this dashboard.

Old dashboards may not have this field set.

last_modified_at holds the timestamp this dashboard was last updated by an user.

Old dashboards may not have this field set.

last_modified_by holds the username who last updated this dashboard.

Old dashboards may not have this field set.

meta_data includes version metadata about the dashboard.

name is the dashboard name, displayed at the top of the dashboard.

description may include details about what is displayed in the dashboard.

widgets list of widgets in the dashboard.

key is the unique identifier. It always must be defined.

If set, will create or update a dashboard.

name is the dashboard name, displayed at the top of the dashboard.

description may include details about what is displayed in the dashboard.

widgets list of widgets in the dashboard.

dashboard_id holds the id of the dashboard

schema_version is managed internally.

legacy_key holds the key of a previous version of the dashboard, in case it was migrated.

legacy_version tells from which version the dashboard was migrated from.

from_package records the contributing package key and version, if applicable.

width of the widget in the UI, represented in number of cells.

height of the widget in the UI, represented in number of cells.

tags includes the values to be matched in the dashboard description.

Tags are matched by word. Generally, a tag is prefixed by a ‘#’,

which must be omitted when provided here.

All provided tags must match inside a dashboard for it to be returned.

E.g., to match “#devices”, the tag should be set to “devices”.

default_dashboard is the default dashboard shown to a user.

To unset, use an empty key ({dashboard_id: nil}) in a Set() call.

x represents a position in the horizontal axis.

y represents a position in the vertical axis.

id holds the unique identifier for the widget inside a dashboard

name of the widget is displayed at the top of the widget.

position of the widget, represented as a (x,y) coordinate in a grid.

Top left is at (0,0).

dimensions of the widget represents how many cell in the grid it takes.

type is the widget type. Each type is handled differently in the UI,

and can use different inputs.

inputs contains metadata about the data the widget will display, encoded in a JSON string.

Internal data vary based on the widget type type and is managed by the client.

location is used as a position display hint, used and managed by the UI.

styles represents the widget’s panel appearance.

parent stores the id of its parent widget.

hide_title is used to hint the dashboard that the widget title must be hidden.

background_color is used to set the widget’s background color.

hide_horizontal_bar is used to hint the dashboard that the title separator must be hidden.

title_size is used to set widget’s title size.

values holds a list of widgets

PartialEqFilter provides a way to server-side filter a DeleteAll.

This requires all provided fields to be equal to the response.

A filtered DeleteAll will use GetAll with filter to find things to delete.

This describes the class of delete error.

A DeleteAllResponse is only sent when there is an error.

This indicates the error message from the delete failure.

This is the key of the DashboardConfig instance that failed to be deleted.

Time indicates the (UTC) timestamp when the key was being deleted.

Key indicates which DashboardConfig instance to remove.

This field must always be set.

Key echoes back the key of the deleted DashboardConfig instance.

Time indicates the (UTC) timestamp at which the system recognizes the

deletion. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==DeletedAt will not include this instance.

key contains a list of DashboardConfig keys to delete

Key uniquely identifies a DashboardConfig instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

DashboardConfig instance in this response.

DashboardConfig carries the value to set into the datastore.

See the documentation on the DashboardConfig struct for which fields are required.

Value carries all the values given in the DashboardConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

value contains a list of DashboardConfig values to write.

It is possible to provide more values than can fit within either:

- the maxiumum send size of the client

- the maximum receive size of the server

If this error occurs you must reduce the number of values sent.

See gRPC “maximum message size” documentation for more information.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each DashboardConfig at end.

* Each DashboardConfig response is fully-specified (all fields set).

* start: Returns the state of each DashboardConfig at start, followed by updates until now.

* Each DashboardConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each DashboardConfig at start, followed by updates

until end.

* Each DashboardConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this DashboardConfig’s last modification.

Operation indicates how the DashboardConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Key uniquely identifies a Dashboard instance to retrieve.

This value must be populated.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

Dashboard instance in this response.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Error is an optional field.

It should be filled when there is an error in the GetSome process.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

For each Dashboard in the list, all populated fields are considered ANDed together

as a filtering operation. Similarly, the list itself is ORed such that any individual

filter that matches a given Dashboard is streamed to the user.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each Dashboard at end.

* Each Dashboard response is fully-specified (all fields set).

* start: Returns the state of each Dashboard at start, followed by updates until now.

* Each Dashboard response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each Dashboard at start, followed by updates

until end.

* Each Dashboard response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this Dashboard’s last modification.

Operation indicates how the Dashboard value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Time indicates the time for which you are interested in the data.

If no time is given, the server will use the time at which it makes the request.

Value is the value requested.

This structure will be fully-populated as it exists in the datastore. If

optional fields were not given at creation, these fields will be empty or

set to default values.

Time carries the (UTC) timestamp of the last-modification of the

GlobalDashboardConfig instance in this response.

GlobalDashboardConfig carries the value to set into the datastore.

See the documentation on the GlobalDashboardConfig struct for which fields are required.

Value carries all the values given in the GlobalDashboardConfigSetRequest as well

as any server-generated values.

Time indicates the (UTC) timestamp at which the system recognizes the

creation. The only guarantees made about this timestamp are:

- it is after the time the request was received

- a time-ranged query with StartTime==CreatedAt will include this instance.

PartialEqFilter provides a way to server-side filter a GetAll/Subscribe.

This requires all provided fields to be equal to the response.

While transparent to users, this field also allows services to optimize internal

subscriptions if filter(s) are sufficiently specific.

TimeRange allows limiting response data to within a specified time window.

If this field is populated, at least one of the two time fields are required.

For GetAll, the fields start and end can be used as follows:

* end: Returns the state of each GlobalDashboardConfig at end.

* Each GlobalDashboardConfig response is fully-specified (all fields set).

* start: Returns the state of each GlobalDashboardConfig at start, followed by updates until now.

* Each GlobalDashboardConfig response at start is fully-specified, but updates may be partial.

* start and end: Returns the state of each GlobalDashboardConfig at start, followed by updates

until end.

* Each GlobalDashboardConfig response at start is fully-specified, but updates until end may

be partial.

This field is not allowed in the Subscribe RPC.

Value is a value deemed relevant to the initiating request.

This structure will always have its key-field populated. Which other fields are

populated, and why, depends on the value of Operation and what triggered this notification.

Time holds the timestamp of this GlobalDashboardConfig’s last modification.

Operation indicates how the GlobalDashboardConfig value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Time holds the timestamp of the last item included in the metadata calculation.

Operation indicates how the value in this response should be considered.

Under non-subscribe requests, this value should always be INITIAL. In a subscription,

once all initial data is streamed and the client begins to receive modification updates,

you should not see INITIAL again.

Count is the number of items present under the conditions of the request.