v1
latestOpenAPI 3.0.02026-07-14498851.7 MBscores
Get BSI (Breach Susceptibility Indicator)
Retrieve BSI (Breach Susceptibility Indicator) for a single company.
get/companies/{scorecard_identifier}/scores/{score_type}
Path parameters
scorecard_identifierstring required
Primary identifier of a company or scorecard in SecurityScorecard.
score_typestring required
Type of score to retrieve. Currently only breach_likelihood is supported. Other values will be normalized to breach_likelihood by the service.
Query parameters
from-datestring date required
Start date for filtering score history (inclusive). Format: ISO 8601 date string (YYYY-MM-DD)
to-datestring date required
End date for filtering score history (inclusive). Format: ISO 8601 date string (YYYY-MM-DD)
Response
Successfully retrieved score data