List Firm Performance Metrics

get

https://mock-api.carta.com/v1alpha1/investors/firms/{firmId}/metrics

Scope: read_investor_fundperformance

Retrieve aggregated fund performance metrics for a given firm.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

firmId

string

required

The firm ID for which to retrieve the aggregated fund performance metrics.

Query Params

fundIds

string

A comma-separated list of fund IDs for which to retrieve aggregated metrics. If unspecified, will aggregate 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, i.e. 'YYYY-MM-DDThh:mm:ssZ'. If unspecified, defaults to the current date and time.

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.

groupBy

string

enum

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.

AGGREGATION_TYPE_BY_PARTNER_TYPE: Display metrics by groupings of partner types (GP, LP, etc.). See partnerMetrics.partnerType for more details
AGGREGATION_TYPE_BY_PARTNER_GROUP: Display metrics for partners by their groups (same investor across different funds of the firm). See partnerMetrics.partnerType and partnerMetrics.partnerDetails for more details

Allowed:

Responses

200A successful response.

400Returned if required fields are omitted or if provided fields fail validation.

401Returned if a valid Authorization header has not been included with the request.

403Returned when the user does not have permission to access the resource.

500Returned if an unexpected internal server error is encountered.

defaultAn unexpected error response.