GET: Portfolio Products – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/portfolio/products

Get the products used by companies in your portfolio.

Products can be installed on the premises, Infrastructure-as-a-Service products, or other Software-as-a-service offerings; Product types are broader categories that encompass many types of products.

Parameters

See query parameters for details on the following parameters:

fields
limit
offset
q
sort

Example Request

curl https://api.bitsighttech.com/ratings/v1/portfolio/products -u api_token:

Example Response

{
  "count":1,
  "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":2,
      "domain_count":3,
      "percent_dependent":0.1,
      "percent_dependent_company":0.0,
      "relative_importance":5.573602022857138E-6,
      "relative_criticality":"low"
    }
  ]
}

Response Attributes

The server will return an array of objects, each representing a single product which may fall under more than one product type.

Field		Description
count Integer		The number of products used by companies in your portfolio.
results Array		Product details.
	product_guid String [`product_guid`]	The unique identifier of this product.
	product_name String	The name of this product.
	product_types Array	The categories of this product.
	provider_guid String [`entity_guid`]	The unique identifier of the company that supplies this product (service provider).
	provider_name String	The name of the company that supplies this product (service provider).
	provider_industry String	The industry of the company that supplies this product (service provider).
	company_count Integer	The number of unique companies in your portfolio that use this product.
	domain_count Integer	The number of unique domains in your portfolio that use this product.
	percent_dependent Decimal	The percentage of assets (domains) in this response that depends on this product.
	percent_dependent_company Decimal	The percentage of companies in this response that depend on this product.
	relative_importance String	A measurement of this product’s importance. See product importance.
	relative_criticality String	Reiterates the `relative_importance` field. See product importance.

October 15, 2018: Published.

Parameters

Example Request

Example Response

Response Attributes

Related articles