GET: Portfolio Details

Ingrid

https://api.bitsighttech.com/ratings/v2/portfolio

Get information about the companies in your portfolio.

Parameters

Depending on the size of your portfolio, the results may contain a lot of data and will be paginated. Use the next and previous links in the response to access your entire portfolio. Learn more about pagination.

We recommend using the fields parameter to improve performance.

❖ Not applicable for National Cybersecurity subscriptions.

See query parameters for details on the following parameters:

  • fields
  • format
  • limit (Default 100)
  • offset
  • q
  • sort
Parameter Values 
countries

Filter companies by one or more countries in which they have IP addresses.

[String] Country codes. Use EUU for all EU countries and NEU for all non-EU countries.

Example: US,CA

 
exclude_subscription_type.slug

Exclude one or more subscription types.

 [Array] Subscription slug names. See the subscription_types field in GET: Portfolio Summary. 
filter_group

Group filters and modify the way the filters intersect with each other.

[String]

Example to show all the companies with an A in Botnet Infections:

?filter_group=risk_vectors&risk_vectors.slug=botnet_infections&risk_vectors.grade=A
  
risk_vectors.grade

Filter companies with certain risk vector letter grades.

Does not include N/A letter grades.

  • On its own, this includes companies that have any of the specified grades in any risk vector.
  • This can be intersected with the risk_vectors.slug parameter.

[String]

  • Risk vector letter grades.
  • Use filter_group=risk_vectors to filter by specific grades in specific risk vectors.
 
risk_vectors.slug

Filter companies with graded risk vectors.

  • On its own, this includes companies with a grade in any of the specified risk vectors.
  • This can be intersected with the risk_vectors.grade parameter.

[String]

  • Risk vector slug names. See risk types.
  • Use filter_group=risk_vectors to filter by specific grades in specific risk vectors.
 
software.category

Filter companies by the supported statuses of their software.

  • On its own, this includes companies that have at least one software of any of the specified categories.
  • This can be intersected with the software.name parameter.

[String]

  • The supported status:
    • Supported
    • Unsupported
    • Unknown
  • Use filter_group=software to filter by specific software in specific categories.
 
software.name

Filter companies with certain software detected on their network.

  • On its own, this includes companies that have any of the specified software, across all software categories.
  • This can be intersected with the software.category parameter.

[String]

  • Software name.
  • Use filter_group=software to filter by specific software in specific categories.
 
folder

Filter companies by folder.

[Array]

  • Folder unique identifiers [folder_guid]. See GET: Folder Details.
  • null to include companies that are not in a folder.
 
industry.name

Filter companies by their industry.

 [String] Industry name. Use GET: Industries with the show_all parameter set to true [/v1/industries?show_all=true]. 
industry.slug

Filter companies by their industry.

 [String] Industry slug name. Use GET: Industries with the add_sub_industries and show_all parameters set to true [/v1/industries?add_sub_industries=true&show_all=true]. 
infections

Filter companies that have certain infections.

 [Array] Comma-separated infection names. See the infections field in GET: Portfolio Summary. 
life_cycle.slug

❖ Filter companies by their Life Cycle stage.

[String]

Example: 'onboarding,null'

 
open_ports

Filter companies by open ports.

[Array] Comma-separated service names and port numbers.

Example: 'SIP,Port 8081'

 
products

Filter by companies that use certain service provider products.

 [Array] Comma-separated product names. See the products key in GET: Portfolio Summary. 
product_types

Filter by companies that use certain service provider product types.

 [Array] Comma-separated product types. See the product_types field in GET: Portfolio Summary. 
providers

Filter companies that rely on certain service providers.

 [String] The name of the service provider. See the providers field in GET: Portfolio Summary. 
rating

Filter companies by their rating.

 [Integer] A 10-point incremental number between 250 and 900. 
rating_gt

Filter companies that have a rating greater than the given value.

 [Integer] A 10-point incremental number between 250 and 900. 
rating_gte

Filter companies that have a rating greater than or equal to the given value.

 [Integer] A 10-point incremental number between 250 and 900. 
rating_lt

Filter companies that have a rating less than the given value.

 [Integer] A 10-point incremental number between 250 and 900. 
rating_lte

Filter companies that have a rating less than or equal to the given value.

 [Integer] A 10-point incremental number between 250 and 900. 
relationship.slug

❖ Filter companies of certain relationships.

 [String] Relationship slug name. 
security_incident_categories

Filter companies (including their subsidiaries) that have been affected by a Public Disclosures event in the past year.

 [Array] Comma-separated Public Disclosure risk type slug names. 
subscription_type.slug

Filter companies by subscription type.

 [Array] Comma-separated subscription slug names. 
tier

Filter companies by their tier.

[String]

  • Tier unique identifiers [tier_guid]. See GET: Tiers.
  • null to include companies that are not in a tier.
 
type

Filter companies by rating type.

 [String] Rating type name. See rating types. 
vendor_action_plan

❖ Filter companies by action plan.

[String] Action plan slug name.

  • monitor
  • review
  • escalate
 
vulnerabilities

Filter companies that have certain vulnerabilities.

 [Array] Comma-separated vulnerability names. See the vulnerabilities field in GET: Portfolio Summary.

Example Request

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

Example Response

{
  "links":{
    "previous":null,
    "next":"null"
  },
  "count":4,
  "summaries":{
    "my-company":"a940bb61-33c4-42c9-9231-c8194c305db3"
  },
  "results":[
    {
      […]
      "guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "custom_id":null,
      "name":"Actors Films",
      "shortname":"Actors Films",
      "network_size_v4":512,
      "rating":750,
      "rating_date":"2020-09-20",
      "added_date":"2018-01-22",
      "industry":{
        "name":"Media/Entertainment",
        "slug":"mediaentertainment"
      },
      "sub_industry":{
        "name":"Motion Pictures and Film",
        "slug":"motion_pictures_and_film"
      },
      "type":[
        "CURATED",
        "PRIVATE"
      ],
      "logo":"https://api.bitsighttech.com/ratings/v1/companies/1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9/logo-image",
      "sparkline":"https://api.bitsighttech.com/ratings/v1/companies/1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9/sparkline?size=small",
      "subscription_type":{
        "name":"Risk Monitoring",
        "slug":"alerts-only"
      },
      "primary_domain":"actorsfilms.us",
      "display_url":"https://service.bitsighttech.com/app/company/1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9/overview/",
      "tier":"e325bd1d-b5ee-4fa5-a1ee-8e87518b0746",
      "tier_name":"Tier 2",
      "life_cycle":{
        "name":"Onboarding",
        "slug":"onboarding"
      },
      "relationship":{
        "name":"Subsidiary",
        "slug":"subsidiary"
      }
    }
  ]
}

Response Attributes

Field Description 
links

Object

 Navigation for multiple pages of results. See pagination.
  
previous

String

 The URL to navigate to the previous page of results. 
next

String

 The URL to navigate to the next page of results. 
count

Integer

 The number of companies in your portfolio. 
summaries

Object

 Your organization.
  
my-company

String [entity_guid]

 The unique identifier of your organization. 
results

Array

 Companies in your portfolio.
  
guid

String [entity_guid]

 The unique identifier of this entity in your portfolio. 
custom_id

String

 An identifier for this entity, as defined by your organization. 
name

String

 The name of this entity. 
shortname

String

 The abbreviated name of this entity. 
network_size_v4

Integer

 The number of unique IP addresses that belong to this entity. 
rating

Integer

 The current Bitsight Security Rating of this entity. 
rating_date

String [YYYY‑MM‑DD]

 The date when this rating was generated. 
added_date

String [YYYY‑MM‑DD]

 The date when this entity was added to your portfolio. 
industry

Object

 The industry of this entity.
  
name

String

 The name of this industry. 
slug

String

 The slug name of this industry. 
sub_industry

Object

 The sub-industry of this entity.
  
name

String

 The name of this sub-industry. 
slug

String

 The slug name of this sub-industry. 
type

Array

 The rating types. 
logo

String

 The URL where this entity’s logo image file is stored in the Bitsight platform. 
sparkline

String

 The URL path to the 1-year trend line of this entity’s ratings. 
subscription_type

Object

 The subscription used by your organization to subscribe to this entity.
  
name

String

 The name of this subscription. 
slug

String

 The slug name of this subscription. 
primary_domain

String

 The main domain that belongs to this entity. 
display_url

String

 The URL path to this entity's overview page in the Bitsight platform. 
tier

String [tier_guid]

 The unique identifier of this entity’s tier. 
tier_name

String

 The name of the tier. 
life_cycle

Object

 The current Life Cycle stage of this entity.
  
name

String

 The name of this Life Cycle stage. 
slug

String

 The slug name of this Life Cycle stage. 
relationship

String

 Your organization's relationship with this entity (company relationship).
  
name

String

 The name of this company relationship. 
slug

String

 The slug name of this company relationship.
  • December 5, 2023: How to get industry & sub-industry names.
  • November 28, 2022: Parameter recommendations for performance and pagination.
  • September 22, 2020: New field, tier_name; New parameter, countries.
Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.