List Fund Performance Metrics

Scope: read_investor_fundperformance

Retrieve a list of fund performance metrics for a given firm and fund. This endpoint also supports returning performance metrics across all funds of a firm if the caller submits a - (dash) character for the fund identifier.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The firm ID for which to retrieve fund performance metrics.

string
required

The fund ID for which to retrieve fund performance metrics. Use a - (dash) to retrieve metrics for all funds.

Query Params
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.

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.

  • 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 andpartnerMetrics.partnerDetails for more details
Allowed:
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.

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.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json