GET: Grades by Country-Industry

https://api.bitsighttech.com/ratings/v1/territories/country_guid/industries/industry_guid/grades/

Get risk vector grades from a particular country-industry.

Available for National Cybersecurity.

Parameters

* Required.

country_guid

* Required.

[Path] Identify the country to query.

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

industry_guid

* Required.

[Path] Identify the country-industry to query.

Value: [String] Industry unique identifier [industry_guid]. See GET: Ratings of Industries Within a Country.

period

[Query] Set a time period.

Value: [String]

  • latest (default) = Today’s grades.
  • monthly = Grades on the first day of each month during the last 12 months.

Example Request

curl https://api.bitsighttech.com/ratings/v1/territories/5d04c480-b1e7-48af-9633-82996a8446fc/industries/08da2e31-2b5b-4457-9fe5-c740904282b3/grades/ -u api_token:

Example Response

{
  "guid":"5d04c480-b1e7-48af-9633-82996a8446fc",
  "name":"Demo Country 1 - Technology",
  "rating_date":"2021-09-01",
  "grades":[
    {
      "risk_vector":{
        "name":"Botnet Infections",
        "slug":"botnet",
        "risk_category":"Compromised Systems"
      },
      "grade":"A",
      "percentile":100.0
    }
  ]
}

Response Attributes

Field Description
guid

String [entity_guid]

The unique identifier of the country.
name

String

The name of the country and industry.
rating_date

String [YYYY-MM-DD]

The date when the grades were calculated.
grades

Array

Grades grouped by risk vector.
 
risk_vector

Object

Risk vector information.
 
name

String

The name of this risk vector.
slug

String

The slug name of this risk vector.
risk_category

String

The category of this risk vector.
grade

String

The letter grade of this risk vector.
percentile

Decimal

The percentile this country is placed in, based on its rating within the industry.

Response Codes

See common errors and status codes.

200 – Okay
Everything worked as expected.
401 – Unauthorized
  • You are not subscribed to the country.
  • You are not subscribed to the region.
404 – Not Found
The territory or industry was not found.
  • October 15, 2021: Published.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.