3.1. Specify fund-level data for analysis
The portfolio to be analysed is specified by creating an analysis job with a specification of holdings and their weights in the portfolio. A unique alphanumeric identifier (external id) must be specified for each analysis job, to be used later to retrieve the analysis results. Multiple simultaneous analysis jobs can be created.
Endpoint
Use the endpoint listed below to initiate a fund-level analysis by specifying your portfolio’s details. Enter a unique external identifier {external_id} to define the portfolio you wish to analyse. This identifier allows you to create multiple analysis jobs and retrieve results efficiently.
Path
https://api.thisismatter.com/partner-api/v1/analysis/jobs?external_id={your_external_id}
Request method
The POST method is used to securely transmit your client ID and client secret to request an access token. This ensures sensitive information is sent safely over HTTPS, adhering to best practices for creating new authentication tokens.
Method
POST
Request
The request must contain an JSON object with the holdings and their weights in the portfolio. In addition, an identifier for the portfolio should also be included. The identifier can be any alphanumeric string and include dashes and underscores.
{
"holdings": [
{
"id_value": "US0378331005",
"weight": 0.123
},
{
"id_value": "US5949181045",
"weight": 0.06
},
{
"id_value": "LU1503114545",
"weight": 0.3
}
],
"default_id_scheme": "ISIN"
}
Response
Upon successful upload a 201- Created status will be returned, and the response containing the portfolio identifier, which can be used to retrieve the analysis results.
{
"created": "2023-07-10T09:24:10.413291",
"time_stamp": 1688981050,
"external_id": "EX-123456789"
}
3.2 Retrieve analysed results
Results for portfolio analysis are obtained by requesting the results of an analysis job. The same set of metrics will be returned for all requests. Metrics with no data for a given portfolio will be omitted from the results.
Aggregated analysis results are generally available after two seconds from the upload of portfolio holdings. This varies for the size of the portfolio and the type of entities in the portfolio. For valid requests where the analysis is not yet ready a status code of 202 - Accepted will be returned.
Endpoint
Use the endpoint listed below to initiate a fund-level analysis by specifying your portfolio’s details. Enter a unique external identifier {external_id} to define the portfolio you wish to analyse. This identifier allows you to create multiple analysis jobs and retrieve results efficiently.
Path
https://api.thisismatter.com/partner-api/v1/analysis/jobs/{external_id}
Request method
The GET method is used to retrieve data from the server, such as accessing specific analysis results or portfolio details. This method requests information securely over HTTPS, ensuring data integrity and confidentiality while adhering to best practices for retrieving data from the API.
Method
GET
Response
Upon successful return of an analysis a 200 - OK will be returned, and the response containing the metrics for the specified portfolio.
{
"created": "2023-07-10T09:24:10.413291",
"time_stamp": 1688981050,
"external_id": "fund name",
"holdings_matched": 1.0,
"analysis": {
"basic": [
{
"metric_id": "f10a915d-708a-4eba-ad4b-6ff6b6dc0b9b",
"metric_name": "SDG_ALL_A_CAPEX",
"metric_value": {
"raw": 2.1899119435638137,
"extrapolated": 18.178219814619435
},
"coverage": {
"weight": 0.12046899893919344,
"entity_count": 21
},
"metric_unit": "PERCENTAGE OF CAPEX",
"metric_type": "sdg_capex_metric"
},
]
}
}
