Report Schema Reference
This page is generated from deterministic sample output written by the Picket report writers. It documents field presence and ordering, not live finding values.
Native Reports
Section titled “Native Reports”Native reports carry Picket schema metadata such as picket.report.v1 and picket.finding.v1, stable hashes, validation state, provenance, and rule metadata.
Native JSON report object
Section titled “Native JSON report object”| Property | JSON type |
|---|---|
schema |
string |
tool |
object |
scan |
object |
rules |
array<object> |
findings |
array<object> |
Native JSON rules[] object
Section titled “Native JSON rules[] object”| Property | JSON type |
|---|---|
id |
string |
description |
string |
pattern |
string |
pathPattern |
string |
secretGroup |
number |
entropy |
number |
randomnessThreshold |
number |
detector |
string |
severity |
string |
confidence |
string |
rulePack |
string |
provider |
string |
documentationUrl |
string |
validation |
array |
revocation |
array |
deprecated |
boolean |
keywords |
array<string> |
tags |
array<string> |
skipReport |
boolean |
Native JSON findings[] object
Section titled “Native JSON findings[] object”| Property | JSON type |
|---|---|
schema |
string |
ruleId |
string |
description |
string |
file |
string |
symlinkFile |
string |
startLine |
number |
endLine |
number |
startColumn |
number |
endColumn |
number |
positionKind |
string |
match |
string |
secret |
string |
secretSha256 |
string |
matchSha256 |
string |
blobSha256 |
string |
line |
string |
commit |
string |
entropy |
number |
randomness |
object |
author |
string |
email |
string |
date |
string |
message |
string |
tags |
array<string> |
fingerprint |
string |
validationState |
string |
severity |
string |
confidence |
string |
rulePack |
string |
provider |
string |
documentationUrl |
string |
provenance |
object |
decodePath |
array<string> |
baselineStatus |
string |
ignoreReason |
string |
remediationLinks |
array<string> |
link |
string |
Native JSON findings[].randomness object
Section titled “Native JSON findings[].randomness object”| Property | JSON type |
|---|---|
model |
string |
score |
number |
classification |
string |
sampleOffset |
number |
sampleLength |
number |
alphabet |
string |
lengthScore |
number |
normalizedEntropy |
number |
expectedDistinctRatio |
number |
transitionDiversity |
number |
longestRunRatio |
number |
sequentialPairRatio |
number |
repeatedPatternRatio |
number |
commonBigramRatio |
number |
characterClassBalance |
number |
encodedTextSignal |
number |
placeholderSignal |
number |
signals |
array<string> |
Native JSON findings[].provenance object
Section titled “Native JSON findings[].provenance object”| Property | JSON type |
|---|---|
type |
string |
path |
string |
commit |
string |
Native JSONL finding object
Section titled “Native JSONL finding object”| Property | JSON type |
|---|---|
schema |
string |
ruleId |
string |
description |
string |
file |
string |
symlinkFile |
string |
startLine |
number |
endLine |
number |
startColumn |
number |
endColumn |
number |
positionKind |
string |
match |
string |
secret |
string |
secretSha256 |
string |
matchSha256 |
string |
blobSha256 |
string |
line |
string |
commit |
string |
entropy |
number |
randomness |
object |
author |
string |
email |
string |
date |
string |
message |
string |
tags |
array<string> |
fingerprint |
string |
validationState |
string |
severity |
string |
confidence |
string |
rulePack |
string |
provider |
string |
documentationUrl |
string |
provenance |
object |
decodePath |
array<string> |
baselineStatus |
string |
ignoreReason |
string |
remediationLinks |
array<string> |
link |
string |
Native JSONL randomness object
Section titled “Native JSONL randomness object”| Property | JSON type |
|---|---|
model |
string |
score |
number |
classification |
string |
sampleOffset |
number |
sampleLength |
number |
alphabet |
string |
lengthScore |
number |
normalizedEntropy |
number |
expectedDistinctRatio |
number |
transitionDiversity |
number |
longestRunRatio |
number |
sequentialPairRatio |
number |
repeatedPatternRatio |
number |
commonBigramRatio |
number |
characterClassBalance |
number |
encodedTextSignal |
number |
placeholderSignal |
number |
signals |
array<string> |
Native CSV columns
Section titled “Native CSV columns”| Position | Column |
|---|---|
| 1 | Schema |
| 2 | RuleID |
| 3 | Description |
| 4 | File |
| 5 | SymlinkFile |
| 6 | StartLine |
| 7 | EndLine |
| 8 | StartColumn |
| 9 | EndColumn |
| 10 | PositionKind |
| 11 | Secret |
| 12 | SecretSha256 |
| 13 | Match |
| 14 | MatchSha256 |
| 15 | BlobSha256 |
| 16 | DecodePath |
| 17 | Line |
| 18 | Commit |
| 19 | Entropy |
| 20 | RandomnessModel |
| 21 | RandomnessScore |
| 22 | RandomnessClassification |
| 23 | RandomnessSampleOffset |
| 24 | RandomnessSampleLength |
| 25 | RandomnessAlphabet |
| 26 | RandomnessLengthScore |
| 27 | RandomnessNormalizedEntropy |
| 28 | RandomnessExpectedDistinctRatio |
| 29 | RandomnessTransitionDiversity |
| 30 | RandomnessLongestRunRatio |
| 31 | RandomnessSequentialPairRatio |
| 32 | RandomnessRepeatedPatternRatio |
| 33 | RandomnessCommonBigramRatio |
| 34 | RandomnessCharacterClassBalance |
| 35 | RandomnessEncodedTextSignal |
| 36 | RandomnessPlaceholderSignal |
| 37 | RandomnessSignals |
| 38 | Author |
| 39 | Email |
| 40 | Date |
| 41 | Message |
| 42 | Fingerprint |
| 43 | ValidationState |
| 44 | Severity |
| 45 | Confidence |
| 46 | RulePack |
| 47 | Provider |
| 48 | DocumentationUrl |
| 49 | ProvenanceType |
| 50 | BaselineStatus |
| 51 | IgnoreReason |
| 52 | Tags |
| 53 | Link |
Native TOON sections
Section titled “Native TOON sections”| Section | Fields |
|---|---|
findings |
schema,ruleId,description,file,symlinkFile,startLine,endLine,startColumn,endColumn,positionKind,match,secret,secretSha256,matchSha256,blobSha256,decodePath,line,commit,entropy,randomnessModel,randomnessScore,randomnessClassification,randomnessSampleOffset,randomnessSampleLength,randomnessAlphabet,randomnessLengthScore,randomnessNormalizedEntropy,randomnessExpectedDistinctRatio,randomnessTransitionDiversity,randomnessLongestRunRatio,randomnessSequentialPairRatio,randomnessRepeatedPatternRatio,randomnessCommonBigramRatio,randomnessCharacterClassBalance,randomnessEncodedTextSignal,randomnessPlaceholderSignal,randomnessSignals,author,email,date,message,fingerprint,validationState,severity,confidence,rulePack,provider,provenanceType,baselineStatus,ignoreReason,link |
findingTags |
findingIndex,tag |
rules |
id,description,pattern,pathPattern,secretGroup,entropy,randomnessThreshold,detector,severity,confidence,rulePack,provider,documentationUrl,skipReport |
ruleKeywords |
ruleIndex,keyword |
ruleTags |
ruleIndex,tag |
Native SARIF root object
Section titled “Native SARIF root object”| Property | JSON type |
|---|---|
$schema |
string |
version |
string |
runs |
array<object> |
Native SARIF driver object
Section titled “Native SARIF driver object”| Property | JSON type |
|---|---|
name |
string |
fullName |
string |
informationUri |
string |
rules |
array<object> |
Native SARIF rule object
Section titled “Native SARIF rule object”| Property | JSON type |
|---|---|
id |
string |
name |
string |
shortDescription |
object |
defaultConfiguration |
object |
properties |
object |
Native SARIF result object
Section titled “Native SARIF result object”| Property | JSON type |
|---|---|
ruleId |
string |
level |
string |
kind |
string |
message |
object |
locations |
array<object> |
partialFingerprints |
object |
properties |
object |
Native SARIF result randomness object
Section titled “Native SARIF result randomness object”| Property | JSON type |
|---|---|
model |
string |
score |
number |
classification |
string |
sampleOffset |
number |
sampleLength |
number |
alphabet |
string |
lengthScore |
number |
normalizedEntropy |
number |
expectedDistinctRatio |
number |
transitionDiversity |
number |
longestRunRatio |
number |
sequentialPairRatio |
number |
repeatedPatternRatio |
number |
commonBigramRatio |
number |
characterClassBalance |
number |
encodedTextSignal |
number |
placeholderSignal |
number |
signals |
array<string> |
GitLab Code Quality object
Section titled “GitLab Code Quality object”| Property | JSON type |
|---|---|
description |
string |
check_name |
string |
fingerprint |
string |
severity |
string |
location |
object |
Native JUnit XML elements
Section titled “Native JUnit XML elements”| Element |
|---|
failure |
properties |
property |
testcase |
testsuite |
testsuites |
Gitleaks-Compatible Reports
Section titled “Gitleaks-Compatible Reports”Compatibility reports keep the Gitleaks-shaped field names and ordering expected by existing integrations.
Gitleaks-compatible JSON finding object
Section titled “Gitleaks-compatible JSON finding object”| Property | JSON type |
|---|---|
RuleID |
string |
Description |
string |
StartLine |
number |
EndLine |
number |
StartColumn |
number |
EndColumn |
number |
Match |
string |
Secret |
string |
File |
string |
SymlinkFile |
string |
Commit |
string |
Link |
string |
Entropy |
number |
Author |
string |
Email |
string |
Date |
string |
Message |
string |
Tags |
array<string> |
Fingerprint |
string |
Gitleaks-compatible CSV columns
Section titled “Gitleaks-compatible CSV columns”| Position | Column |
|---|---|
| 1 | RuleID |
| 2 | Commit |
| 3 | File |
| 4 | SymlinkFile |
| 5 | Secret |
| 6 | Match |
| 7 | StartLine |
| 8 | EndLine |
| 9 | StartColumn |
| 10 | EndColumn |
| 11 | Author |
| 12 | Message |
| 13 | Date |
| 14 | Email |
| 15 | Fingerprint |
| 16 | Tags |
| 17 | Link |
Gitleaks-compatible JUnit XML elements
Section titled “Gitleaks-compatible JUnit XML elements”| Element |
|---|
failure |
testcase |
testsuite |
testsuites |
Gitleaks-compatible SARIF root object
Section titled “Gitleaks-compatible SARIF root object”| Property | JSON type |
|---|---|
$schema |
string |
version |
string |
runs |
array<object> |
Gitleaks-compatible SARIF driver object
Section titled “Gitleaks-compatible SARIF driver object”| Property | JSON type |
|---|---|
name |
string |
semanticVersion |
string |
informationUri |
string |
rules |
array<object> |
Gitleaks-compatible SARIF result object
Section titled “Gitleaks-compatible SARIF result object”| Property | JSON type |
|---|---|
message |
object |
ruleId |
string |
locations |
array<object> |
partialFingerprints |
object |
properties |
object |