RArailz
PortfolioMetrics
Portfolio Metrics

GET /portfolioMetrics

Changed on

Gets portfolio metrics for connected business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

reportFrequency'month' | 'quarter' | 'year' required
startDatestring
Example:2020-11-01
endDatestring
Example:2020-11-30

Response

countnumber required

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
        }
      }
    }
  ]
}

Changes