clients
Get Statistics
get/v1/clients/statistics/overview
Query parameters
include_archivedboolean
portfolio_idstring nullable
Scope results to a portfolio. Pass an id from GET /portfolios; omit it (or pass 'all-clients') for no scoping. An unknown, malformed or inaccessible id returns 404 rather than all clients. The camelCase spelling 'portfolioId' is accepted as an alias.
Scope results to a portfolio. Pass an id from GET /portfolios; omit it (or pass 'all-clients') for no scoping. An unknown, malformed or inaccessible id returns 404 rather than all clients. The camelCase spelling 'portfolioId' is accepted as an alias.
Response
Successful Response
{"stackTrail":"paths:/v1/clients/statistics/overview:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
Changed in 1 of the 2 revisions of this API.1
- ○
added the new optional
queryrequest parameterportfolio_idnew-optional-request-parameter
- ○