jobs

Get PII Masking Report

Get the PII masking report for a job that ran with mask_pii: true. Returns a signed download link (valid for up to 300 seconds) and an entity count for each report object; the masked values themselves are only in the downloaded objects. Reports are kept for 90 days after the job ran, then expire automatically (410). Requires a key with the index permission.

get/v2/jobs/{job_id}/pii

Path parameters

job_idstring required

ID of the job whose masking report to act on, as returned by the indexing endpoint that started it.

Response

Successful Response

job_idstring required

statestring required

Always retained on a 200.

entity_countinteger required

Entities across all files.

incompleteboolean

true while the job is still running or reported failed files, so objects may still be missing.

truncated_objectsboolean

true when only the first 500 of the job's report objects are listed.

expires_in_secondsinteger required

Lifetime of every url in the response (up to 300).

Changes

No recorded changes to this endpoint across all 1 revision of this API.