Sign in
Sample

Gets a benchmark sample by its id.

get/benchmark-sample/{sampleId}

Path parameters

sampleIdstring required

The id of the sample to be retrieved.

Response

OK

idstring required

The unique identifier of the sample.

identifierstring required

The identifier used to correlate samples of different participants.

participantIdstring required

The id of the participant that owns the sample.

participantNamestring required

The name of the participant that owns the sample.

englishPromptstring nullable

An optional prompt text translated to English.

originalPromptstring nullable

An optional prompt text as originally provided.

tagsstring[] required

The tags associated with the sample.

createdAtstring date-time

The timestamp when the sample was created.

ownerIdstring uuid nullable

The id of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.

ownerMailstring nullable

The mail of the customer that owns the sample. Null unless the caller is platform staff or a member of the owning organization.

organizationIdstring nullable

The id of the organization that owns the entity. Null unless the caller is platform staff or a member of the owning organization.

Changes