dashboard
get/api/dashboard/summary

Request

Query parameters

monthstring date nullable
balance_datestring date nullable
account_idsstring[] nullable
asset_group_idsstring[] nullable

Headers

X-Workspace-Idstring nullable

Response

Successful Response

total_balanceobject required
total_balance_primarynumber
projected_balanceobject
projected_balance_primarynumber
balance_datestring required
monthly_incomenumber required
monthly_expensesnumber required
monthly_income_primarynumber
monthly_expenses_primarynumber
projected_incomenumber
projected_expensesnumber
projected_income_primarynumber
projected_expenses_primarynumber
accounts_countinteger required
pending_categorizationinteger required
pending_categorization_amountnumber required
assets_valueobject
assets_value_primarynumber
primary_currencystring
fx_fallbackboolean
pending_shares_netnumber

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value {} was removed for the status