Get a dataset's sample redaction
Return the stored redaction for a dataset’s sample: which columns hold personal data, and how
each is masked. Apply it with GET /datasets/{dataset_id}/sample/redacted.
A redaction gets here one of two ways: you upload one with PUT /datasets/{dataset_id}/redaction,
or Narrative’s privacy model writes one. POST /v2/datasets/{dataset_id}/request-sample asks the
model for one in a single call, and the GenerateSampleRedaction workflow task asks for the same
thing as a step in a workflow of your own. model_version tells an uploaded redaction from a
generated one.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Unique identifier for a dataset.
Response
OK
The stored redaction for one dataset's sample.
The dataset this redaction belongs to.
One entry per column that holds personal data.
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_idis 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.
- UserResourceOwner
- AppInstallation
- AppClientCredentials
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.
128When the dataset's first redaction was written. Survives later uploads.
When the redaction was last written or deleted.

