Skip to content
Clarative Docs Clarative Docs Clarative
Get started
API Reference
Risk Events

List all risk events with optional filters

risk_events.list(RiskEventListParams**kwargs) -> RiskEventListResponse
GET/v1/risk-events

List all risk events with optional filters

ParametersExpand Collapse
risk_threshold: Optional[Literal["LOW", "MEDIUM", "HIGH", "CRITICAL"]]

Risk level classification for a risk event.

  • LOW: Minimal impact.
  • MEDIUM: Moderate impact, may require attention.
  • HIGH: Significant impact, likely requires action.
  • CRITICAL: Severe impact, requires immediate action. It is rare to encounter this.
Accepts one of the following:
"LOW"
"MEDIUM"
"HIGH"
"CRITICAL"
vendor_urn: Optional[str]

A vendor's unique identifier

ReturnsExpand Collapse
List[RiskEventListResponseItem]
ai_risk_level_recommendation: Optional[RiskEventListResponseItemAIRiskLevelRecommendation]

AI's risk level recommendation for this event, if available. AI recommendations are made automatically, shortly after a risk event is discovered.

explanation: str

The explanation for the AI's risk level recommendation

Accepts one of the following:
created_at: datetime

An ISO-8601-formatted timestamp representing when the risk event was created (UTC)

formatdate-time
description: Optional[str]

The risk event's description

name: str

The risk event's display name

review_status: Literal["PENDING", "VERIFYING", "APPLICABLE", "NOT_APPLICABLE"]

The current review status of the risk event, representing where it is in the triage process.

Accepts one of the following:
"PENDING"
"VERIFYING"
"APPLICABLE"
"NOT_APPLICABLE"
risk_level: Optional[Literal["LOW", "MEDIUM", "HIGH", "CRITICAL"]]

Risk level classification for a risk event.

  • LOW: Minimal impact.
  • MEDIUM: Moderate impact, may require attention.
  • HIGH: Significant impact, likely requires action.
  • CRITICAL: Severe impact, requires immediate action. It is rare to encounter this.
Accepts one of the following:
"LOW"
"MEDIUM"
"HIGH"
"CRITICAL"
source_type: Literal["STATUS_PAGE", "MONITOR", "NEWS", "SEC_FILING"]

The type of the risk event

Accepts one of the following:
"STATUS_PAGE"
"MONITOR"
"NEWS"
"SEC_FILING"
url: Optional[str]

A URL with more information about the risk event

urn: str

A unique identifier for the risk event

List all risk events with optional filters

import os
from clarative import Clarative

client = Clarative(
    api_key=os.environ.get("CLARATIVE_API_KEY"),  # This is the default and can be omitted
)
risk_events = client.risk_events.list()
print(risk_events)
[
  {
    "ai_risk_level_recommendation": {
      "explanation": "explanation",
      "recommended_risk_level": "LOW"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "review_status": "PENDING",
    "risk_level": "LOW",
    "source_type": "STATUS_PAGE",
    "url": "url",
    "urn": "urn"
  }
]
Returns Examples
[
  {
    "ai_risk_level_recommendation": {
      "explanation": "explanation",
      "recommended_risk_level": "LOW"
    },
    "created_at": "2019-12-27T18:11:19.117Z",
    "description": "description",
    "name": "name",
    "review_status": "PENDING",
    "risk_level": "LOW",
    "source_type": "STATUS_PAGE",
    "url": "url",
    "urn": "urn"
  }
]