SAsalesforce
samples

Find samples

Find a sample or samples. 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/samples

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/samples
  • Auth
    API key in header Authorization

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 sample name; asterisk (*) wildcards ok.

messageCodestring

Filter by sample messageCode; asterisk (*) wildcards ok.

statusstring

Filter by sample status (Critical|Invalid|Timeout|Warning|Info|OK).

previousStatusstring

Filter by sample previousStatus (Critical|Invalid|Timeout|Warning|Info|OK).

valuestring

Filter by sample value (BOOLEAN|NUMERIC|PERCENT).

Response

Success, returns a list of samples.

messageBodystring

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.

messageCodestring

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.

valuestring

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.

providerstring

User who provided this sample.

createdAtstring

TODO

updatedAtstring

TODO

statusChangedAtstring

Time at which the status changed from one state to another.

Changes

No recorded changes to this operation across all 70 revisions of this API.