GET: Findings Summaries

Jessica

https://api.bitsighttech.com/ratings/v1/companies/company_guid/findings/summaries

Summarized findings data for a company in your ratings tree.

Parameters
Example Response
Response Attributes

Parameters

* Required.

See query parameters for details on the format (value: json) parameter.

You may also use the query parameters listed in GET: Finding Details with this endpoint.

company_guid

* Required.

[Query] Identify the company to query.

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

fields

[Query] Filter by fields.

Value: [Array] Comma-separated field names, which are available in the response. The order of the specific fields might not be reflected in the response when using this parameter.

expand

[Query] Include additional information.

Value: [String] findings_severity_counts = Include findings counts by severity.

This parameter is only available for this endpoint if you have Attack Surface Analytics.

Example Response

{
  "findings_count": 10,
  "findings_risk_vector_counts": [
    {
      "count": 2,
      "risk_vector": {
        "slug": "spf"
      }
    },
    {
      "count": 8,
      "risk_vector": {
        "slug": "dkim"
      }
    }
  ]
}

Response Attributes

Field				Description
findings_count Integer				The number of findings.
findings_risk_vector_counts Array				The number of findings per risk vector.
	Object
		count Integer		The number of findings for this risk vector.
		risk_vector Object		The risk vector and its slug.
			slug String	The slug of the risk vector.
findings_severity_counts Array				The number of findings per severity.
	Object
		category String		The severity category.
		count Integer		The number of findings for this severity category.

July 15, 2024: Published.