GET: Portfolio Statistics

https://api.bitsighttech.com/ratings/v1/portfolio/statistics

Get portfolio statistics, including:

• The distribution of companies across rating categories (advanced, intermediate, basic).
• The highest, lowest, and median security ratings.
• Risk vector averages.

Parameters

folder

[Query] Show only companies in a specified folder.

Value: [String] Folder unique identifier [folder_guid]. See GET: Folder Details.

rating_date

[Query] Get statistics from a particular date, up to 1 year prior.

Value: [String] YYYY-MM-DD

tier

[Query] Include only companies that are part of the specified tier(s). Untiered companies are included via an “untiered” alias.

Value: [String] Comma-separated tier unique identifiers [tier_guid]. See GET: Tiers.

types

[Query] Specify a type of statistic to return: security rating statistics or risk vector statistics.

Value: [String]

• ratings
• risk_vector_averages

Example Request

curl https://api.bitsighttech.com/ratings/v1/portfolio/statistics -u api_token:

Example Response

{
  "risk_vector_averages":[
    […]
    {
      "risk_vector_id":"breach",
      "risk_vector":"Security Incidents",
      "average_grade":"A",
      "companies_below_average":130,
      "percent_companies_below_average":1.13
    }
  ],
  "ratings":{
    "min_rating":300,
    "max_rating":810,
    "median_rating":720,
    "entity_count_by_bucket":{
      "advanced":5228,
      "intermediate":5655,
      "basic":1186
    }
  }
}

Response Attributes

risk_vector_averages

risk_vector_id

risk_vector

average_grade

companies_below_average

percent_companies_below_average

ratings

min_rating

max_rating

median_rating

entity_count_by_bucket

advanced

intermediate

basic