Request data for a portfolio

Using the portfolioId to request data at portfolio level

The portfolioId can be stored and used to request information on the portfolio level by passing it as a parameter to any of the portfolio level endpoints - assuming you have access to the module in question. Please see below as an example:

Note portfolioId was provided when creating the portfolio see Create a portfolio or can be retrieved using the List portfolios functionality.

In this example, we will use the ESG Risk module to retrieve scores for a portfolio.

To retrieve a portfolio summary aGET call to ESG Risk - Get Specific Scores for Portfolio is needed and with the following information:

1. portfolioId is passed as the PATH PARAM: https://api.clarity.ai/clarity/v1/public/portfolios/{portfolioId}/esg-risk/scores-by-id
2. scoreId is passed as a QUERY PARAM and is a string of the score measure to retrieve.

Sample response

{
  "scoringProfileId": "ESG_RISK_INDUSTRY_CONSENSUS",
  "scores": [
    {
      "id": "ESG",
      "pillar": "ESG",
      "treeLevel": "TOTAL",
      "score": 62,
      "metadata": "NONE",
      "relevance": 90
    }
  ]
}