Skip to main content
GET
Get a dataset's sample redaction

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dataset_id
integer
required

Unique identifier for a dataset.

Response

OK

The stored redaction for one dataset's sample.

dataset_id
integer
required

The dataset this redaction belongs to.

columns
object[]
required

One entry per column that holds personal data.

written_by
UserResourceOwner · object
required

Who was authenticated when the redaction was written, taken from the access token rather than from anything the caller sent. One variant per kind of grant a token can carry, each tagged with type:

  • user_resource_owner: a token issued directly to a user of a company.
  • app_installation: a token issued to an app a company installed. user_id is null when the app issued itself the token rather than acting for a user.
  • app_client_credentials: a token issued to an app on its own credentials, which carries no user and no company.
Example:
model_version
string | null
required

The privacy model that produced the redaction, named by the model repository the worker loaded. A deployment can point the worker at a different repository, so read the value rather than expecting a fixed one.

Null on a redaction you uploaded yourself: PUT /datasets/{dataset_id}/redaction refuses this field from any caller but Narrative, and an upload that leaves it out clears a stored value.

Maximum string length: 128
created_at
string<date-time>
required

When the dataset's first redaction was written. Survives later uploads.

updated_at
string<date-time>
required

When the redaction was last written or deleted.