v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
aspects

Find aspects

Find an aspect or aspects. You may query using field filters with asterisk (*) wildcards. You may also optionally specify sort, limit, offset, and a list of fields to include in the response. The global default limit will apply if no limit param is specified.

get/aspects

Query parameters

fieldsstring[]

Comma-delimited list of field names to include in the response.

sortstring[]

Specify the sort order using a field name, e.g. '...?sort=name'. Prepend the field name with a minus sign to specify descending order, e.g. '...?sort=-name'.

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

namestring

Filter by aspect name; asterisk (*) wildcards ok.

descriptionstring

Filter by aspect description; asterisk (*) wildcards ok.

imageUrlstring

Filter by aspect imageUrl; asterisk (*) wildcards ok.

isPublishedboolean

Filter by aspect isPublished (true|false).

rankstring

Filter by aspect rank.

timeoutstring

Filter by aspect timeout; asterisk (*) wildcards ok.

valueLabelstring

Filter by aspect valueLabel; asterisk (*) wildcards ok.

valueTypestring

Filter by aspect valueType (BOOLEAN|NUMERIC|PERCENT).

statusstring

Filter by aspect status.

tagsstring[]

Comma-separated list of tags to include/exclude. Tag names are case-insensitive. For example, ?tags=FOO,BAR will only return aspects with tags FOO and BAR. Prefix each of the tag name with a negative sign to indicate that a aspect with that tag should be excluded. For example, ?tags=-BAZ,FOO will return only the aspects with tag name not equal to BAZ or FOO. A mix of tag names with and without minus signs, for example ?tags=BAZ,-FOO are not allowed. Aspects without tags are not included in the include result set.

createdAtstring

Filter by time period when aspects were created.

updatedAtstring

Filter by time period when aspects were updated.

Response

Success, returns a list of aspects.

descriptionstring

A description of the aspect. A lens may choose to display this information to the user.

helpEmailstring

The email address where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.

helpUrlstring

The url where a user can go to get more help about the aspect. A lens may choose to display this information to the user e.g. if the user clicks a “help” icon attached to the aspect.

idstring

The aspect id.

imageUrlstring

Optional icon to represent the aspect.

isPublishedboolean

This affects the visibility of samples; defaults to false. When set to true, all the samples for this aspect are readable by other users; when set to false, the samples for this aspect are only readable by the owner of the aspect.

namestring

Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

criticalRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 0.

warningRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 1.

infoRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 2.

okRangenumber[]

A two-element array of type decimal. Determines what range of values should be assigned to status value 3.

timeoutstring

The length of time after which a sample is treated as 'N/A', in the form of /^[0-9]+[smhd]$/i. For example, use '5s' for five seconds, '2m' for two minutes, '12h' for twelve hours, '1d' for one day.

valueLabelstring

A short label the lens may display next to the value. Most useful to specify a unit of measurement, e.g. 'ms' or '%'.

valueType'BOOLEAN' | 'NUMERIC' | 'PERCENT'

The sample value must be able to be coerced to the specified data type. This allows a lens to render sample data in different ways depending on their type.

createdBystring

Id of the User who created this Aspect.

createdAtstring

TODO

updatedAtstring

TODO

tagsstring[]

Array of tag names. Tag name: Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Tag names cannot start with a dash (-).

Example response

[
  {
    "criticalRange": [
      1,
      7
    ],
    "warningRange": [
      1,
      7
    ],
    "infoRange": [
      1,
      7
    ],
    "okRange": [
      1,
      7
    ]
  }
]