[GET] Get impact ratings

Modified on Tue, 11 Feb at 3:46 AM

https://api.s7risk.com

The Incident API provides well constructed high-quality, highly-tailored and scalable threat intelligence data.

`GET /impact-ratings`Get impact ratings

This endpoint provides information about our impact ratings.

HTTP Request

curl -X GET 'https://api.s7risk.com/impact-ratings' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  -d 'search=permanent' \
  -d 'sort=rating:desc' \
  -d 'page=1' \
  -d 'pageSize=10' \
  --compressed

Headers

Name	Type	Required	Description
`Authorization`	string	✔️	Your authentication token (see the Auth API section for more information)

Query Parameters

Name	Type	Description
`search`	string	Search impact rating descriptions using the given search term
`sort`	string	Sort the results by the given properties. Available options `rating:asc` or `rating:asc`. If no sort order is specified then results are sorted by their rating
`page`	int	A paginated result set. Defaults to `1`
`pageSize`	int	A limited result set. Defaults to `100`

HTTP Response

{
    "data": [
        {
            "rating": 5,
            "shortDescription": "Extreme",
            "longDescription": "Fatalities, multiple permanent disabilities or hospitalisation. Significant financial loss, more than $50,000. Significant business interruption, more than 6 lost time workdays. Major negative reputational exposure. Outside assistance required to contain risk. Significant irreversible impacts."
        },
        {
            "rating": 4,
            "shortDescription": "Major",
            "longDescription": "Permanent disability or multiple hospitalisations, major health effects. Major financial loss, more than $10,000 USD but less than $50,0000 USD. Major business interruption, 3-6 lost time work days. Major negative reputational exposure. Outside assistance required to contain risk. Some irreversible impacts."
        }
    ]
}

Success

Code	Status	Description
200	Success	Returns a body containing all valid impact ratings.

Errors

Code	Status	Description
401	Unauthorized	Expired or Invalid Authentication token