GET: Shared Service Provider Domains

https://api.bitsighttech.com/ratings/v1/companies/company_guid/providers/provider_guid/domains

Get the domains that are shared by a company and their service provider.

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.

provider_guid

* Required.

[Path] Identify the service provider to query.

Value: [String] The service provider's unique identifier [entity_guid]. See GET: Service Providers for a Specific Domain.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/providers/a5e23bf0-38d4-4cea-aa50-19ee75da481d/domains -u api_token:

Example Response

{
  "count":11,
  "results":[
    […]
    {
      "importance":0.75,
      "criticality":"high",
      "domain_name":"saperix.com",
      "product_count":5
    }
  ]
}

Response Attributes

Field Description
count

Integer

The number of domains.
results

Array

Domain objects.
  Object A domain and its details.
 
importance

Decimal

A measurement of the product’s importance.
Values:
  • 0.005 = Low Criticality
  • .005.075 = Medium Criticality
  • .075.5 = High Criticality
  • .51 = Critical Criticality
criticality

String

Reiterates the importance field.

Values:
  • low = 0 ↹ .005 Importance
  • medium = .005 ↹ .075 Importance
  • high = .075 ↹ .5 Importance
  • critical = .5 ↹ 1 Importance
domain_name

String

The name of the shared domain.
product_count

Integer

The number of shared products in the domain.
  • October 9, 2020: Added criticality to the response.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.