POST: Get Products of a Company

Jessica

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

Get the enterprise products used at the domains of a particular company.

Parameters
Example Request
Example Response
Response Attributes

Parameters

* Required.

See query parameters for details on the following parameters:

fields
limit (Default: ↻ All)
offset
q
sort

company_guid

* Required.

[Path] Identify the company to query.

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

product_guid

[Body] Identify the products to query.

Value: [Array] Product unique identifier [product_guid].

product_types

[Body] Identify the product types to query.

Value: [Array] Product types. See product types by business function.

provider_guid

[Body] Identify the providers to query.

Value: [Array] The unique identifier of the product provider [entity_guid]. See GET: Portfolio Details.

provider_name

[Body] Identify the providers to query by their names.

Value: [Array] Product provider's name.

relative_criticality

[Body] Identify the relative criticality to query by.

Value: [Array] Relative criticality.

Values:

low

medium

high

critical

relationship_source

[Body] Identify the relationship source to query.

Value: [Array] See fourth party relationships.

Example Request

POST command
curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/products
-H 'Content-Type: application/json' 
--data-binary '{
  "q":"acme"
}' 
--compressed 
-u api_token:

Example Response

[
  {
    "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":100.0,
    "relative_importance":0.10714285714285714,
    "relative_criticality":"high",
    "relationship_source":"bitsight"
  }
]

Response Attributes

The server will return an array with the following object:

Field	Description
product_guid String [`product_guid`]	The unique identifier of the product.
product_name String	The name of the product.
provider_name String	The name of the product provider.
product_types Array	This product’s business functions.
provider_guid String [`entity_guid`]	The unique identifier of the product provider.
provider_name String	The name of the product provider.
provider_industry String	The industry of the product provider.
company_count Integer	The number of companies that use this product.
domain_count Integer	The number of domains that use this product.
percent_dependent Decimal	The percentage of assets (domains) in this response that depend on this product.
percent_dependent_company Decimal	The percentage of companies in this response that depend on 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`
relationship_source String	How the relationship between this company and the product provider was curated. See fourth party relationships.

June 22, 2023: Added additional parameters.
May 16, 2023: Published.