| Time | Status | User Agent |  |
| :-- | :-- | :-- | :-- |
| Make a request to see history. |

#### URL Expired

The URL for this request expired after 30 days.

### Request Parameters

#### firmId
- **Type**: string  
- **Required**: Yes  
- **Description**: The firm ID for which to retrieve the aggregated fund performance metrics.

#### fundIds
- **Type**: string  
- **Description**: A comma-separated list of fund IDs for which to retrieve aggregated metrics. If unspecified, will aggregate all funds.

#### asOfDateTime
- **Type**: date-time  
- **Description**: The date and time as of which the data should be retrieved. Uses UTC and is specified in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), i.e. 'YYYY-MM-DDThh:mm:ssZ'. If unspecified, defaults to the current date and time.

#### pageSize
- **Type**: int32  
- **Description**: The maximum number of results to return. The service may return fewer than this value.
  - If unspecified, at most 25 items will be returned.
  - The maximum value is 50; values above 50 will be coerced to 50.

#### pageToken
- **Type**: string  
- **Description**: A page token received as `nextPageToken` in a previous response. Provide this to retrieve the subsequent page. All other parameters must be kept consistent with those used in the request where the page token was obtained.

#### groupBy
- **Type**: string (enum)  
- **Description**: Specifies how the fund metrics should be aggregated. If not set, or set to `AGGREGATION_TYPE_UNSPECIFIED`, will aggregate all metrics into a single result.
  - **Allowed Values**:  
    - `AGGREGATION_TYPE_BY_PARTNER_TYPE`
    - `AGGREGATION_TYPE_BY_PARTNER_GROUP`

### Response

#### 200: A successful response.
**Response message for listing firm performance metrics**.

- **firmId**: string  
  - The firm ID to which these performance metrics belong.

- **selectedFunds**: array of objects  
  - A list of the funds that were aggregated to produce these performance metrics.

- **selectedFunds object**  
    - **fundId**: string  
      - The ID of the fund to which this performance metric belongs.
    - **fundName**: string (length ≤ 1000)  
      - The name of the fund.
    - **fundEntityType**: string (enum)

- **firmPerformanceMetrics**: array of objects  
  - List of aggregated fund performance metrics.

- **firmPerformanceMetrics object**  
    - **commitment**: object  
      - The committed capital.
    - **contributedCapitalItd**: object  
      - Inception-to-date contributed capital.
    - **cumulativeDistributionsItd**: object  
      - Inception-to-date cumulative distributions.
    - **nav**: object  
      - Net Asset Value (NAV) of the funds.
    - **netTotalValue**: object  
      - Total value including distributions and NAV.
    - **irr**: object  
      - Internal Rate of Return (IRR). A value of `0.1` represents 10%.
    - **dpi**: object  
      - Distributions to paid-in capital (DPI) ratio.
    - **rvpi**: object  
      - Residual value to paid-in capital (RVPI) ratio.
    - **tvpi**: object  
      - Total value to paid-in capital (TVPI) ratio.
    - **previousQuarterEndIrr**: object  
      - IRR as of the previous quarter's end.
    - **partnerType**: string (enum)

- **partnerMetrics**: object  
  - Partner metrics for aggregated performance.

- **nextPageToken**: string  
  - Token to retrieve the next page of results.

- **groupedBy**: string (enum)  
  - Indicates how the metrics were aggregated.

### Error Responses

- **400**: Returned if required fields are omitted or if provided fields fail validation.
- **401**: Returned if a valid `Authorization` header has not been included with the request.
- **403**: Returned when the user does not have permission to access the resource.
- **500**: Returned if an unexpected internal server error is encountered.
- **default**: An unexpected error response.

### Example Request

```bash
curl --request GET \
     --url https://mock-api.carta.com/v1alpha1/investors/firms/firmId/metrics \
     --header 'accept: application/json'
```

### Example Response

```json
{
  "firmId": "7af7123a-2ee9-4e31-a173-54b8f9159426",
  "selectedFunds": [
    {
      "fundId": "09051fa3-fe71-4613-9bfb-e5bfa396cfea",
      "fundName": "Krakatoa Ventures Fund I, L.P.",
      "fundEntityType": "FUND"
    }
  ],
  "groupedBy": "AGGREGATION_TYPE_BY_PARTNER_TYPE",
  "firmPerformanceMetrics": [
    {
      "commitment": {
        "amount": {
          "value": "100000.00"
        },
        "currencyCode": "USD"
      },
      "contributedCapitalItd": {
        "amount": {
          "value": "11000.00"
        },
        "currencyCode": "USD"
      },
      "cumulativeDistributionsItd": {
        "amount": {
          "value": "0.00"
        },
        "currencyCode": "USD"
      },
      "nav": {
        "amount": {
          "value": "5172.23"
        },
        "currencyCode": "USD"
      },
      "netTotalValue": {
        "amount": {
          "value": "5172.23"
        },
        "currencyCode": "USD"
      },
      "irr": {
        "value": "-0.22"
      },
      "dpi": {
        "value": "0.00"
      },
      "rvpi": {
        "value": "0.47"
      },
      "tvpi": {
        "value": "0.47"
      },
      "previousQuarterEndIrr": {
        "value": "-0.24"
      },
      "partnerType": "LIMITED_PARTNER"
    }
  ],
  "nextPageToken": "ODMxMw=="
}
```