Get portfolio overview

GET/api/v1/advisory-firms/{firm_id}/reports/portfolio-overview

Quick access to the client portfolio overview report.

Operation ID: get_portfolio_overview_api_v1_advisory_firms__firm_id__reports_portfolio_overview_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_idstringrequired

Responses

200Successful Response

Schema: app__core__success__SuccessEnvelope_GetPortfolioOverviewResponse___2

successboolean
messagestring
codestring
dataapp__api__v1__schemas__advisory_firm_reports__GetPortfolioOverviewResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/advisory-firms/{firm_id}/reports/portfolio-overview

bash

curl -X GET 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/reports/portfolio-overview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'