---
title: "GET /portfolioMetrics"
method: GET
path: "/portfolioMetrics"
tags: ["Portfolio Metrics"]
---

# GET /portfolioMetrics

`GET /portfolioMetrics`

Gets portfolio metrics for connected business.

## Query parameters

- `reportFrequency` 'month' | 'quarter' | 'year', required
- `startDate` string
- `endDate` string

## Response `200`

- PortfolioMetricsResponseDto
  - `count` number, required
  - `reports` PortfolioMetricsReport[], required
    - `meta` PortfolioMetricsReportMetaData, required
      - `startDate` string, date-time, required
      - `endDate` string, date-time, required
      - `reportFrequency` string, required
      - `createdAt` string, date-time, required
    - `data` PortfolioMetricsReportData, required
      - `section` SummaryStatisticsData, required
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `subSection` SummaryStatisticsData, required
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `group` SummaryStatisticsData, required
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `subGroup` SummaryStatisticsData, required
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `ratios` SummaryStatisticsData
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `pds` SummaryStatisticsData
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required
      - `creditScores` SummaryStatisticsData
        - `min**` number, float, required
        - `max**` number, float, required
        - `mean**` number, float, required
        - `median**` number, float, required
        - `sdev**` number, float, required
        - `quantile5**` number, float, required
        - `quantile25**` number, float, required
        - `quantile75**` number, float, required
        - `quantile95**` number, float, required

## Other responses

- `202` — Data in pending state
- `204` — No data available
- `400` — Bad Request Error - Thrown if fields sent via query does not follow specifications
- `401` — Unauthorized - Not logged in or log in expired
- `403` — Forbidden - Not enough permission
- `500` — Server Error

---

[API](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api.md) · [All operations](https://skmtc.net/railz/apis/fis-accounting-data-as-a-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/railz/fis-accounting-data-as-a-service-api/revisions/5cdfae3fa1fa/schema)