GET: Products in a Folder

Ingrid

https://api.bitsighttech.com/ratings/v1/folders/folder_guid/products

Get service provider products that companies in a folder depend on.

Parameters

* Required.

See query parameters for details on the following parameters:

fields
limit
offset
q
sort

folder_guid

* Required.

[Path] Identify the folder to query.

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

Example Request

curl https://api.bitsighttech.com/ratings/v1/folders/12349876-bbbb-5555-bbbb-example55555/products/ -u api_token:

Example Response

{
  "count":123,
  "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":1,
      "percent_dependent":0.2,
      "percent_dependent_company":33.3,
      "relative_importance":0.015697703143963113,
      "relative_criticality":"medium"
    }
  ]
}

Response Attributes

Field		Description
count Integer		The number of products in the folder.
results Array		Service provider product details of the folder.
	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 within this folder that depend on this product.
	domain_count Integer	The number of unique domains within this folder that have this product.
	percent_dependent Decimal	The percentage of assets (domains) in this folder that depends on this product.
	percent_dependent_company Decimal	The percentage of companies in this folder that depend on this product.
	relative_importance Decimal	A measurement of this product’s importance. See product importance.
	relative_criticality String	Reiterates the `relative_importance` field. See product importance.

October 9, 2020: Added the count, results, provider_industry, percent_dependent_company, relative_importance, relative_criticality fields to the response.