---
title: "Client Data Portfolio Summary"
method: POST
path: "/api/analytics/contributor/portfolio-summary"
tags: ["Contributor Data"]
---

# Client Data Portfolio Summary

`POST /api/analytics/contributor/portfolio-summary`

## Request

- Base URL: `https://api.creditbenchmark.com`
- URL: `https://api.creditbenchmark.com/api/analytics/contributor/portfolio-summary`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/docs/api/analytics/contributor/portfolio-summary/post.ts> (a function with typed inputs; its response is checked against the schema)

Return grouped client portfolio metrics.

## Request body

- RequestEnvelopeClientDataSummaryRequest
  - `Parameters` ClientDataSummaryRequest, required
    - `portfolio` Portfolio, required
      - `name` string, required
      - `entities` FlexibleCBPortfolio, required
        - `CBId` string[]
    - `facet_column` string, required: Column to group by (e.g., ClientType, Sector, Industry)
    - `EffectiveDateId` integer
    - `rating_change_months` integer: Number of months to look back for rating changes (e.g., 24 for 2-year changes)
    - `use_client_scale` boolean
    - `use_oci` boolean

## Response `200`

Client data portfolio summary retrieved successfully

- ClientDataSummaryResponse: Response containing client data portfolio summary comparing client vs benchmark ratings
  - `CBSector` string[], required: Values of the grouping column (matches facet_column parameter)
  - `entity_count` integer[], required: Total number of entities in each group
  - `benchmark_entity_count` integer[], required: Number of entities with benchmark ratings
  - `ClientRating` string[], required: Client's internal aggregate rating
  - `ExMeRating` string[], required: Benchmark rating (excluding client)
  - `notch_difference` integer[], required: Notch difference between client and benchmark (positive = client more conservative)
  - `ClientPD` number[], required: Client's aggregate probability of default
  - `ExMePD` number[], required: Benchmark aggregate probability of default (excluding client)
  - `notch_diff_aggressive` integer[], required: Notch difference using aggressive methodology
  - `notch_diff_consistent` integer[], required: Notch difference using consistent methodology
  - `notch_diff_conservative` integer[], required: Notch difference using conservative methodology

## Other responses

- `400`: Bad request - invalid parameters
- `401`: Unauthorized - invalid or missing JWT token
- `403`: Forbidden - insufficient permissions or access denied
- `422`: Validation error - request parameters are invalid
- `500`: Internal server error

---

[API](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api.md) - [All operations](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/llms.txt) - [OpenAPI document](https://skmtc.dev/creditbenchmark/apis/credit-benchmark-api/revisions/b357bbdb41e6?raw)