GET: Portfolio Risk Vector Grades

Ingrid

https://api.bitsighttech.com/ratings/v1/portfolio/risk-vectors/grades

Get risk vector grades of organizations in your portfolio..

Parameters
Example Request
Example Response
Response Attributes
Response Codes

Parameters

See query parameters for details on the following parameters:

limit (default: ↻ 100)
offset (default: ↻ 0)

company.guid

[Query] Filter by company.

Value: [String] Company unique identifier [entity_guid]. See GET: Portfolio Details.

folder

[Query] Filter by folder.

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

period

[Query] Set a time period.

Value: [String]

↻ latest = Grades from the most recent date.
monthly = A 1-year, monthly history of risk vector grades from the first day of each month.

tier

[Query] Filter by tier.

Value: [String] Tier unique identifier [tier_guid]. See GET: Tiers.

Example Request

curl https://api.bitsighttech.com/ratings/v1/portfolio/risk-vectors/grades -u api_token:

Example Response

{
  {
    "company":{
      "guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
      "name":"Black Hills Technologies"
    },
    "grades":[
      {
        "date":"2021-10-15",
        "risk_vectors":[
          {
            "risk_vector":{
              "name":"Botnet Infections",
              "slug":"botnet",
              "risk_category":"Compromised Systems"
            },
            "grade":"A",
            "percentile":100.0
          }
        ]
      }
    ]
  },
  […]
  ]
}

Response Attributes

Field						Description
company Object						Information about the queried company.
	guid String [`entity_guid`]					The company’s unique identifier.
	name String					The company’s name.
grades Array						Risk vector grades grouped by date.
	Object					Risk vector grades on the specified date.
		date String [`YYYY-MM-DD`]				The date when this grade was calculated.
		risk_vectors Array				Grades grouped by risk vector.
			Object			Risk vector grade data.
				risk_vector Object		Risk vector information.
					name String	This risk vector’s name.
					slug String	This risk vector’s slug name.
					risk_category String	This risk vector’s risk category.
				grade String		The letter grade assigned to this risk vector.
				percentile Decimal		The percentile this company is placed in, based on its rating within the industry.

Response Codes

See common errors and status codes.

200 – Okay: Everything worked as expected.
400 – Bad Data: This can often be due to missing a required parameter.
401 – Unauthorized: You do not have permission to access this resource.
404 – Not Found: The specified resource was not found or does not exist.

November 21, 2022: Added folder and tier parameters.
June 27, 2022: Added limit, offset, & company.guid parameters; Added 400, 401, & 404 status codes.