Skip to main content
Security Performance Management
Continuous Monitoring
Vendor Risk Management
Cyber Insurance
National Cybersecurity

GET: Tier Summaries

Ingrid

⇤ Tiers

https://api.bitsighttech.com/ratings/v1/tiers/summary

Get a summary of your tiers, including action plan and risk threshold information.

Parameters

Parameter Values 
folder

[Query] Filter by folder.

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

Example Request

curl 'https://api.bitsighttech.com/ratings/v1/tiers/summary' -u api_token:

Example Response

[
  {
    "guid":"86b6ffa2-ca5a-4585-9fbf-b22f9be8e99b",
    "name":"Tier 1",
    "count":84,
    "categories":[
      {
        "count":54,
        "vendor_action_plan":"monitor",
        "name":"monitor",
        "rating":{
          "lt":700,
          "gte":null
        }
      },
      […]
      }
    ]
  }
  […]
]

Response Attributes

Field Description 
guid
String [tier_guid]		 The unique identifier of this tier. 
name
String 		The name of this tier. 
count
Integer 		The number of companies in this tier. 
categories
Array 		The distribution of companies in a particular action plan phase.
  
count
Integer 		The number of companies in this action plan phase. 
vendor_action_plan
String 		The slug name of this action plan phase. 
name
String 		The name of this action plan phase. 
rating
Object 		The risk thresholds set for companies in this rating category.
  
lt
Integer 		This risk threshold is set to include any company with less than this security rating value. 
gte
Integer 		This risk threshold is set to include any company with greater than or equal to this security rating value.
  • November 18, 2020: Updated field descriptions to reflect the New TPRM Experience.
  • May 27, 2020: Published.

Related articles

Feedback

0 comments

Please sign in to leave a comment.