Skip to navigation

Retrieve a measurement for an animal

Retrieves a single set of readings taken on an animal.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

animalIdstringRequiredformat: "^aml_[a-zA-Z0-9]{10,22}$"
The unique identifier of the animal.
measurementIdstringRequiredformat: "^mst_[a-zA-Z0-9]{10,22}$"
The unique identifier of the measurement.

Headers

X-Studies-Api-VersionstringOptional

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

The requested measurement recorded on this animal.
idstringformat: "^mst_[a-zA-Z0-9]{10,22}$"
Unique identifier for a measurement.
measured_atdate or null

The date the readings were taken, which may be earlier than created_at when they were recorded retrospectively.

calculationslist of objects
The values recorded and derived, one entry per configured calculation.
studyobject or null
The study the animal was on when the readings were taken. Null when the animal is not on a study.
animalobject
The animal a record belongs to, as embedded in dosages, measurements, observations and samples. Carries the same attributes as an animal retrieved directly, except that the cage, study and treatment group are given as identifiers rather than embedded objects.
userobject or null
The user who recorded the readings.
created_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

updated_atdatetime

UTC timestamp with microsecond precision, always suffixed with Z, in the form yyyy-MM-ddTHH:mm:ss.SSSSSSZ.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error