GET: Subsidiary Statistics

Ingrid

https://api.bitsighttech.com/ratings/v1/subsidiaries/statistics

Get your subsidiaries’ statistics.

Parameters

See query parameters for details on the following parameters:

format – ↻ json (default), xml, csv
end_date
start_date

include_subscription_type

[Query] Filter by subscription type.

Value: [String] my_subsidiary

lens

[Query] Apply a filter: security rating or risk type.

Value: [String]

↻ ratings (default)
Risk type slug name.

period

[Query] Set a time period.

Value: [String]

daily
weekly
↻ monthly (default)
quarterly

scope

[Query] Limit to the specified scope.

Value: [String] spm

Example Request

curl https://api.bitsighttech.com/ratings/v1/subsidiaries/statistics -u api_token:

Example Response

{
  "links":{
    "next":null,
    "previous":null
  },
  "count":10,
  "results":[
    […]
    {
      "company":{
        "guid":"a16042d0-c8a4-449a-b4ac-9aefad5204c4",
        "name":"Saperix Email Provider",
        "logo":"https://api.bitsighttech.com/ratings/v1/companies/a16042d0-c8a4-449a-b4ac-9aefad5204c4/logo-image"
      },
      "stats":[
        […]
        {
          "date":"2022-06-21",
          "value":"700"
        }
      ]
    }
  ]
}

Response Attributes

Field					Description
links Object					Navigation for multiple pages of results. See pagination.
	next String				The URL for navigating to the next page of results.
	previous String				The URL for navigating to the previous page of results.
count Integer					The number of subsidiaries.
results Array					Subsidiaries and their statistics.
	Object				A subsidiary and their statistics.
		company Object			Details about this subsidiary.
			guid String [`entity_guid`]		This subsidiary’s unique identifier.
			name String		This subsidiary’s name.
			logo String		The Bitsight platform URL where this entity’s logo is stored.
		stats Array			Ratings on specific dates.
			Object		Statistics.
				date String [`YYYY-MM-DD`]	The statistics date.
				value String	The Bitsight Security Rating or risk vector letter grade depending on the `lens` parameter.

Status Codes

See the common errors and status codes.

200 – Okay: Everything worked as expected.
400 – Bad Data: This can often be due to missing a required parameter.
401 – No Authentication: No valid API token was provided.
403 – Unauthorized: You do not have permission to access this resource.
404 – Not Found: The specified resource could not be found or does not exist.

June 23, 2022: Published.