GET: Portfolio Statistics

Ingrid

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

Field			Description
risk_vector_averages Array			Risk vector statistics of your portfolio.
	Object		A risk vector and its statistics.
		risk_vector_id String	The slug name of this risk vector. See risk types.
		risk_vector String	The name of this risk vector. See risk types.
		average_grade String	The average letter grade of companies in your portfolio.
		companies_below_average Integer	The number of companies that are performing below average for this risk vector.
		percent_companies_below_average Decimal	The percentage of companies in your portfolio that are performing below average for this risk vector.
ratings Object			Security rating statistics of companies your portfolio.
	min_rating Integer		The lowest rating in your portfolio.
	max_rating Integer		The highest rating in your portfolio.
	median_rating Integer		The median rating of the companies in your portfolio.
	entity_count_by_bucket Object		The distribution of companies across rating categories (advanced, intermediate, basic).
		advanced Integer	The number of portfolio entities in the advanced rating category.
		intermediate Integer	The number of portfolio entities in the intermediate rating category.
		basic Integer	The number of portfolio entities in the basic rating category.

January 9, 2023: rating_date parameter.
March 31, 2020: Published.