---
title: "Find aspects"
method: GET
path: "/aspects"
tags: ["aspects"]
---

# Find aspects

`GET /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.

## Query parameters

- `fields` string[]
- `sort` string[]
- `limit` integer
- `offset` integer
- `name` string
- `description` string
- `imageUrl` string
- `isPublished` boolean
- `rank` string
- `timeout` string
- `valueLabel` string
- `valueType` string
- `status` string
- `tags` string[]
- `createdAt` string
- `updatedAt` string

## Response `200`

Success, returns a list of aspects.

- AspectsResponse[]
  - `description` string — A description of the aspect. A lens may choose to display this information to the user.
  - `helpEmail` string — 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.
  - `helpUrl` string — 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.
  - `id` string — The aspect id.
  - `imageUrl` string — Optional icon to represent the aspect.
  - `isPublished` boolean — 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.
  - `name` string — Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).
  - `criticalRange` number[] — A two-element array of type decimal. Determines what range of values should be assigned to status value 0.
  - `warningRange` number[] — A two-element array of type decimal. Determines what range of values should be assigned to status value 1.
  - `infoRange` number[] — A two-element array of type decimal. Determines what range of values should be assigned to status value 2.
  - `okRange` number[] — A two-element array of type decimal. Determines what range of values should be assigned to status value 3.
  - `timeout` string — 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.
  - `valueLabel` string — 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.
  - `createdBy` string — Id of the User who created this Aspect.
  - `createdAt` string — TODO
  - `updatedAt` string — TODO
  - `tags` string[] — 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 (-).
  - `Samples` SamplesResponse[] — TODO
    - `messageBody` string — Optional message about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed only on hover or click.
    - `messageCode` string — Optional 5-charater code about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed without having to hover or click.
    - `status` 'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK' — Status.
    - `previousStatus` 'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK' — Previous Status.
    - `value` string — Stored as a string but will be treated as whatever the aspect’s valueType was specified as, i.e. [BOOLEAN|NUMERIC|PERCENT]. If timeout occurs, value is set to null.
    - `provider` string — User who provided this sample.
    - `createdAt` string — TODO
    - `updatedAt` string — TODO
    - `statusChangedAt` string — Time at which the status changed from one state to another.
    - `relatedLinks` RelatedLinkResponse[] — RelatedLinks associated with this model.
      - `name` string — Name of the related link.
      - `url` string — The relatedLink url. For example, a related link associated with a sample can have a link to the source from which that sample information is obtained.
    - `apiLinks` HATEOAS[] — Hypertext As The Engine Of Application State.
      - `href` string, required — URL of the related HATEOAS link you can use for subsequent calls.
      - `rel` string, required — Link relation that describes how this link relates to the previous call.
      - `method` string, required — The HTTP method required for the related call.
  - `relatedLinks` RelatedLinkResponse[] — RelatedLinks associated with this model.
    - `name` string — Name of the related link.
    - `url` string — The relatedLink url. For example, a related link associated with a sample can have a link to the source from which that sample information is obtained.
  - `apiLinks` HATEOAS[] — Hypertext As The Engine Of Application State.
    - `href` string, required — URL of the related HATEOAS link you can use for subsequent calls.
    - `rel` string, required — Link relation that describes how this link relates to the previous call.
    - `method` string, required — The HTTP method required for the related call.

## Other responses

- `400` — Bad Request
- `401` — Authentication Error
- `default` — Error

---

[API](https://skmtc.dev/salesforce/apis/refocus-api.md) · [All operations](https://skmtc.dev/salesforce/apis/refocus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salesforce/refocus-api/revisions/42c2153b047e/schema)