Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `list_media_files()` and `get_media_file()` accept `source="dynamic"` or
`source="url_analysis"`. The parameter is omitted from the request when unset.
- `MediaFile.kind` reports `"video"`, `"screenshot"`, or `None`.
- `UrlAnalysisResponse` carries the scoring fields: `verdict_state`, `threat_score`,
- `UrlAnalysisResponse` carries the scoring fields: `threat_score`,
`risk_level`, `privacy_score`, `privacy_risk_level`, `privacy_breakdown`,
`verdict_provenance`, `impersonation_target`, `completeness`, `intel_detections`,
`metafields`, and `scored_at`. Each is `None` or empty until scoring finishes.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Session control:
concurrent-submission quota.

Scoring fields (`threat_score`, `risk_level`, `privacy_score`, `privacy_risk_level`,
`privacy_breakdown`, `verdict_state`, `verdict_provenance`, `impersonation_target`,
`privacy_breakdown`, `verdict_provenance`, `impersonation_target`,
`completeness`, `intel_detections`, `metafields`, `scored_at`) are `None` or empty until
scoring finishes. Read them after the report reaches `completed`.

Expand Down
2 changes: 1 addition & 1 deletion docs/TYPES.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ peer report type to dynamic/static/cdr — it is guarded separately by

| Type | Purpose |
|------|---------|
| `UrlAnalysisResponse` | Top-level report: `level`, `status`, `general_info`, `screenshot`, optional `ip_info`, `dns_records`, optional `whois`, optional `ssl_certificate`, optional `response_headers`, optional `extracted_file`, optional `threat_analysis`, `pages`, plus the scoring fields `verdict_state`, `threat_score`, `risk_level`, `privacy_score`, `privacy_risk_level`, `privacy_breakdown`, `verdict_provenance`, `impersonation_target`, `completeness`, `intel_detections`, `metafields`, `scored_at`. |
| `UrlAnalysisResponse` | Top-level report: `level`, `status`, `general_info`, `screenshot`, optional `ip_info`, `dns_records`, optional `whois`, optional `ssl_certificate`, optional `response_headers`, optional `extracted_file`, optional `threat_analysis`, `pages`, plus the scoring fields `threat_score`, `risk_level`, `privacy_score`, `privacy_risk_level`, `privacy_breakdown`, `verdict_provenance`, `impersonation_target`, `completeness`, `intel_detections`, `metafields`, `scored_at`. |
| `UrlAnalysisGeneralInfo` | `{url, domain, website_title}`. |
| `UrlAnalysisScreenshot` | `{available: bool}`. Fetch actual bytes with `client.get_screenshot(uuid)`. |
| `UrlAnalysisIpInfo` | `{ip, asn, city, country, isp, organization, threat_status}`. |
Expand Down
1 change: 0 additions & 1 deletion src/threatzone/testing/_responses.py
Original file line number Diff line number Diff line change
Expand Up @@ -781,7 +781,6 @@ def build_url_analysis_response(state: SubmissionState) -> UrlAnalysisResponse:
"threatDetails": [],
},
"pages": [state.final_url] if state.final_url else [target_url],
"verdictState": "final" if state.current_status() == "completed" else "provisional",
"threatScore": _THREAT_SCORE_BY_LEVEL[state.level],
"riskLevel": _RISK_LEVEL_BY_LEVEL[state.level],
"privacyScore": 35,
Expand Down
1 change: 0 additions & 1 deletion src/threatzone/types/url_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,6 @@ class UrlAnalysisResponse(BaseModel):
extracted_file: UrlAnalysisExtractedFile | None = Field(default=None, alias="extractedFile")
threat_analysis: UrlAnalysisThreatAnalysis | None = Field(default=None, alias="threatAnalysis")
pages: list[str]
verdict_state: str | None = Field(default=None, alias="verdictState")
threat_score: int | None = Field(default=None, alias="threatScore")
risk_level: str | None = Field(default=None, alias="riskLevel")
privacy_score: int | None = Field(default=None, alias="privacyScore")
Expand Down
1 change: 0 additions & 1 deletion tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,6 @@ def sample_url_analysis_response() -> dict[str, Any]:
"threatDetails": [{"source": "intel-1", "details": {"family": "EvilKit"}}],
},
"pages": ["https://evil.com/login"],
"verdictState": "final",
"threatScore": 72,
"riskLevel": "High",
"privacyScore": 35,
Expand Down
1 change: 0 additions & 1 deletion tests/test_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -714,7 +714,6 @@ def test_url_analysis_response_keeps_the_scoring_fields(
report = UrlAnalysisResponse.model_validate(sample_url_analysis_response)
assert report.threat_score == 72
assert report.risk_level == "High"
assert report.verdict_state == "final"
assert report.privacy_score == 35
assert report.privacy_risk_level == "Medium"
assert report.privacy_breakdown is not None
Expand Down
Loading