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

#### URL Expired

The URL for this request expired after 30 days.

**firmId**  
string  
required  
The firm ID for which to retrieve fund performance metrics.

**fundId**  
string  
required  
The fund ID for which to retrieve fund performance metrics. Use a `-` (dash) to retrieve metrics for all funds.

**asOfDateTime**  
date-time  
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.

**reportType**  
string  
enum  
The type of fund performance metrics to retrieve. If left blank or set to `REPORT_TYPE_UNSPECIFIED` defaults to `BY_FUND`.

- Using `BY_PARTNER`, the user will be able to fetch all partners in each entity for which they have the permission “Partners” checked.
- Using `BY_PARTNER_TYPE` or `BY_FUND`, the user will be able to fetch metrics aggregated by partner type and fund information for each entity for which they have **either** the permission “Fund administration” **or** the permission “Fund performance” checked.

[Learn how to set up those permissions here.](https://support.carta.com/s/article/vc-firm-permissions)

- **BY_FUND**: Display metrics by fund
- **BY_PARTNER_TYPE**: Display metrics by groupings of partner types. See `partnerMetrics.partnerType` for more details
- **BY_PARTNER**: Display metrics by partner. See `partnerMetrics.partnerType` and `partnerMetrics.partnerDetails` for more details

Allowed:  
`BY_FUND` `BY_PARTNER_TYPE` `BY_PARTNER`

**pageSize**  
int32  
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**  
string  
A page token received as `nextPageToken` in a previous response. Provide this to retrieve the subsequent page.

When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

# ``200      A successful response.

**object**
Response message for listing fund performance metrics.

**fundPerformanceMetrics**  
array of objects  
List of fund performance metrics.

**fundPerformanceMetrics**  
object  
A single fund performance metric.

**firmId**  
string  
The firm ID to which this performance metric belongs.

**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  
The type the fund entity.

**metricsType**  
string  
enum  
The type of performance metric (BY_FUND, BY_PARTNER_TYPE, BY_PARTNER).

**commitment**  
object  
The committed capital.

**commitment object**  
**contributedCapitalItd**  
object  
Inception-to-date contributed capital.

**contributedCapitalItd object**  
**cumulativeDistributionsItd**  
object  
Inception-to-date cumulative distributions.

**cumulativeDistributionsItd object**  
**nav**  
object  
Net Asset Value (NAV) of the fund.

**nav object**  
**netTotalValue**  
object  
Total value including distributions and NAV.

**netTotalValue object**  
**irr**  
object  
Internal Rate of Return (IRR). A value of `0.1` represents 10%.

**irr object**  
**dpi**  
object  
Distributions to paid-in capital (DPI) ratio.

**dpi object**  
**rvpi**  
object  
Residual value to paid-in capital (RVPI) ratio.

**rvpi object**  
**tvpi**  
object  
Total value to paid-in capital (TVPI) ratio.

**tvpi object**  
**previousQuarterEndIrr**  
object  
IRR as of the previous quarter's end.

**previousQuarterEndIrr object**  
**partnerMetrics**  
object  
Optional metrics related to specific partners.

**partnerMetrics object**  
**activeCapitalCalls**  
array of objects  
Information about active capital calls. Note that this will only be populated when `metricsType` is set to `BY_FUND`, and will otherwise be empty.

**activeCapitalCalls**  
object  
**totalAmount**  
object  
The total amount of this active capital call.

**totalAmount object**  
**receivedAmount**  
object  
The amount received for this active capital call.

**receivedAmount object**  
**pendingAmount**  
object  
The amount pending for this active capital call.

**pendingAmount object**  
**date**  
object  
The date of this active capital call.

**The date of this active capital call object**  
**activeDistributions**  
array of objects  
Information about active distributions. Note that this will only be populated when `metricsType` is set to `BY_FUND`, and will otherwise be empty.

**activeDistributions**  
object  
**payableAmount**  
object  
The total payable amount expected to be distributed.

**payableAmount object**  
**distributedAmount**  
object  
The amount that has already been distributed.

**distributedAmount object**  
**date**  
object  
The date of the distribution.

**date object**  
**nextPageToken**  
string  
Token to retrieve the next page of results.

# ``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.

**Updated about 2 months ago**
### ShellNodeRubyPHPPython

**Bearer**

**Base URL**
https://mock-api.carta.com/v1alpha1/investors/firms/{firmId}/funds/{fundId}/metrics

``
xxxxxxxxxx

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

``
xxxxxxxxxx

{
  "fundPerformanceMetrics": [\
    {\
      "firmId": "7af7123a-2ee9-4e31-a173-54b8f9159426",\
      "fundId": "09051fa3-fe71-4613-9bfb-e5bfa396cfea",\
      "fundName": "Krakatoa Ventures Fund I, L.P.",\
      "fundEntityType": "FUND",\
      "metricsType": "BY_PARTNER",\
      "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"\
      },\
      "partnerMetrics": {\
        "ownershipPercentage": {\
          "value": "0.00"\
        },\
        "navCapitalInterest": {\
          "amount": {\
            "value": "5172.23"\
          },\
          "currencyCode": "USD"\
        },\
        "navCarriedInterest": {\
          "amount": {\
            "value": "0.00"\
          },\
          "currencyCode": "USD"\
        },\
        "partnerType": "LIMITED_PARTNER",\
        "partnerDetails": {\
          "partnerName": "Laplante Ventures II, LP",\
          "partnerId": "7af7123a-2ee9-4e31-a173-54b8f9159426",\
          "groupName": "Laplante Ventures",\
          "groupId": " 28f7f604-b264-4c7f-9ab5-bcd6d020797d",\
          "externald": "803908333188137"\
        }\
      }\
    },\
    {\
      "firmId": "7af7123a-2ee9-4e31-a173-54b8f9159426",\
      "firmName": "Krakatoa Ventures",\
      "fundId": "09051fa3-fe71-4613-9bfb-e5bfa396cfea",\
      "fundName": "Krakatoa Ventures Fund I, L.P.",\
      "fundEntityType": "FUND",\
      "metricsType": "BY_PARTNER",\
      "commitment": {\
        "amount": {\
          "value": "600000.00"\
        },\
        "currencyCode": "USD"\
      },\
      "contributedCapitalItd": {\
        "amount": {\
          "value": "66000.00"\
        },\
        "currencyCode": "USD"\
      },\
      "cumulativeDistributionsItd": {\
        "amount": {\
          "value": "0.00"\
        },\
        "currencyCode": "USD"\
      },\
      "nav": {\
        "amount": {\
          "value": "31033.34"\
        },\
        "currencyCode": "USD"\
      },\
      "netTotalValue": {\
        "amount": {\
          "value": "31033.34"\
        },\
        "currencyCode": "USD"\
      },\
      "irr": {\
        "value": "-0.22"\
      },\
      "dpi": {\
        "value": "0.00"\
      },\
      "rvpi": {\
        "value": "0.47"\
      },\
      "tvpi": {\
        "value": "0.47"\
      },\
      "previousQuarterEndIrr": {\
        "value": "-0.24"\
      },\
      "partnerMetrics": {\
        "ownershipPercentage": {\
          "value": "0.01"\
        },\
        "navCapitalInterest": {\
          "amount": {\
            "value": "31033.34"\
          },\
          "currencyCode": "USD"\
        },\
        "navCarriedInterest": {\
          "amount": {\
            "value": "0.00"\
          },\
          "currencyCode": "USD"\
        },\
        "partnerType": "LIMITED_PARTNER",\
        "partnerDetails": {\
          "partnerName": "Gavin Palazzolo",\
          "partnerId": "4b7c60bc-924d-4cca-9cfd-732152fd1fd2",\
          "groupName": "Gavin Palazzolo",\
          "groupId": "4e3ca815-c09b-4a42-adc4-116b0d6e21f2",\
          "externald": "383284094530380"\
        }\
      }\
    }\
  ],

"nextPageToken": "ODMxMw=="
}