Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Reports

Get portfolio ratings report

Retrieves a paginated list of portfolio ratings with their changes over time

get/v1/reports/portfolio_ratings

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 250.

sort_attribute'start_date' | 'end_date' | 'vendor_name' | 'folder' | 'criticality' | 'start_rating' | 'end_rating' | 'rating_change'
Example:rating_change

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

sort_method'ASC' | 'DESC'
Example:DESC

Sort results by ascending or descending order.

days_agointeger
Example:360

This parameter filters results by the number of days ago. This is optional but allows the user to filter results by the number of days ago.

Response

OK

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10
  },
  "data": [
    {
      "criticality": "Uncategorized",
      "end_date": "2021-10-01T22:18:57+00:00",
      "end_rating": "0.6",
      "folder": "Uncategorized",
      "industry": "Healthcare",
      "internal_id": "1234",
      "internal_name": [
        "Riskrecon"
      ],
      "rating_change": "-8.8",
      "start_date": "2021-10-01T22:18:57+00:00",
      "start_rating": "9.4",
      "vendor_name": "Riskrecon, Co."
    }
  ]
}