latestOpenAPI 3.0.02026-08-10233809957.8 KB
5cdfae3fa1fa
Portfolio Metrics
Gets portfolio metrics for connected business.
get/portfolioMetrics
Query parameters
reportFrequency'month' | 'quarter' | 'year' required
startDatestring
endDatestring
Response
Example response
{
"count": 1,
"reports": [
{
"meta": {
"startDate": "2020-11-01T01:02:03Z",
"endDate": "2020-11-30T01:02:03Z",
"reportFrequency": "month",
"createdAt": "2020-11-30T01:02:03Z"
},
"data": {
"section": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"subSection": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"group": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"subGroup": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"ratios": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"pds": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
},
"creditScores": {
"min**": 301.5,
"max**": 22012.5,
"mean**": 6279.7,
"median**": 3739.89,
"sdev**": 21764.54,
"quantile5**": 301.5,
"quantile25**": 301.5,
"quantile75**": 6710.61,
"quantile95**": 7649.75
}
}
}
]
}