SAsalesforce
samples

Get sample

Retrieve the specified sample by its name. You may also optionally specify a list of fields to include in the response.

get/samples/{key}

Request

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

Path parameters

keystring required

The name of the sample to retrieve

Query parameters

fieldsstring[]

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

Response

Success.

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.