GET: Products in a Ratings Tree

Ingrid

https://api.bitsighttech.com/ratings/v1/companies/company_guid/company-tree/products

Get service provider products that are used by companies in a Ratings Tree.

Parameters

* Required.

See query parameters for details on the following parameters:

fields
limit
offset
q
sort

company_guid

* Required.

[Path] Identify the company to query.

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

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/company-tree/products -u api_token:

Example Response

{
  "count":25,
  "results":[
    […]
    {
      "product_guid":"55555555-pppp-rrrr-oooo-dddddddddddd",
      "product_name":"Black Hills POS",
      "product_types":[
        "Order Management"
      ],
      "provider_guid":"a5e23bf0-38d4-4cea-aa50-19ee75da481d",
      "provider_name":"Black Hills Technologies",
      "provider_industry":"Technology",
      "company_count":1,
      "domain_count":2,
      "percent_dependent":8.3,
      "percent_dependent_company":9.1,
      "relative_importance":0.10714285714285714,
      "relative_criticality":"high"
    }
  ]
}

Response Attributes

Field		Description
count Integer		The number of products used by companies in the company's Ratings Tree.
results Array		Product usage details of companies in the company's Ratings Tree.
	product_guid String [`product_guid`]	The unique identifier of this product.
	product_name String	The name of this product.
	product_types Array	This product’s business function.
	provider_guid String [`entity_guid`]	The unique identifier of the service provider for this product.
	provider_name String	The name of the service provider for this product.
	provider_industry String	The industry of the service provider.
	company_count Integer	The number of companies in this Ratings Tree that use this product.
	domain_count Integer	The number of unique domains in this Ratings Tree that use this product.
	percent_dependent Decimal	The percentage of assets (domains) in this Ratings Tree that use this product.
	percent_dependent_company Decimal	The percentage of companies in this Ratings Tree that use this product.
	relative_importance Decimal	A measurement of this product’s importance. Values: `0` ↹ `.005` = Low Criticality `.005` ↹ `.075` = Medium Criticality `.075` ↹ `.5` = High Criticality `.5` ↹ `1` = Critical Criticality
	relative_criticality String	Reiterates the `relative_importance` field. Values: `low` `medium` `high` `critical`

October 14, 2020: Published.