v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Alerts

This resource returns any rating/score changes from new scans in the users portfolio based on the users alert settings.

This resource returns any rating/score changes from new scans in the users portfolio based on the users alert settings. Alert settings can be changed at https://portal.riskrecon.com/portal/alert-center/alert-settings.

get/v1/alerting/rating_changes

Query parameters

pageinteger

Example:1

This parameter is the page number in routes that have pagination.

per_pageinteger

Example:20

This parameter sets the results limit per page. This defaults to 20 and currently has a max of 50.

sort_method'ASC' | 'DESC'

Example:DESC

Sort results by ascending or descending order.

start_datestring date

Filter results after the provided date string in format YYYY-MM-DD. Can't search back further than 1 month.

end_datestring date

This parameter filters results before the provided date string in format YYYY-MM-DD. Defaults to current date. Must be after start_date.

alert_types[]string[]

type of score change alert This parameter is optional but allows the user to filter results by available alert_types.

[
  "rating_improved"
]

Example:date

This parameter is optional but allows the user to sort results of alerting issues by available sort attributes.

Response

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10,
    "total_new": 37
  },
  "rating_change_alerts": [
    {
      "id": 20,
      "new": true,
      "seen": true,
      "company_name": "Riskrecon, Co.",
      "security_domain_key": "software_patching",
      "risk_structure": "Uncategorized",
      "alert_type": "rating_improved",
      "previous_rating": {
        "letter": "a",
        "value": "10"
      },
      "new_rating": {
        "letter": "a",
        "value": "10"
      },
      "rating_change": "5",
      "date": "2023-01-03",
      "current_analysis": "15"
    }
  ]
}