Get Plan Summary

Get account- or client-scoped Plan aggregates: goal status breakdown, initiative status counts, and budget forecast by quarter.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^(eq):.+$

Optional encoded client identifier. When omitted, the summary is calculated for the authenticated account.

string
^(eq|in):.+$

Narrows the summary to clients assigned to any supplied user. Use eq: for one user or in: for multiple users.

filter[created_at]
array of strings

Optional creation-date window. Repeat the parameter to bound each side with the
standardized operators: gte: for the inclusive lower bound and lte:
for the inclusive upper bound, each an ISO 8601 UTC instant. The budget forecast
derives its quarter window from this range.

filter[created_at]
boolean

Include the legacy embedded budget forecast. Defaults to true for compatibility;
consumers that call the Budget Summary resource separately can set this to false.

filter[client.segment_id]
array of strings

Narrows results to clients in any supplied segment. Repeat eq: for each segment, or use in: with a
comma-separated list. Use null:true to match clients with no segment; combined with ids it matches either.

filter[client.segment_id]
filter[client.vertical_id]
array of strings

Narrows results to clients in any supplied vertical. Repeat eq: for each vertical, or use in: with a
comma-separated list. Use null:true to match clients with no vertical; combined with ids it matches either.

filter[client.vertical_id]
filter[client.client_access_group_id]
array of strings

Narrows results to clients in any supplied client access group. Repeat eq: for each group, or use in: with
a comma-separated list. Use null:true to match clients with no access group; combined with ids it matches
either.

filter[client.client_access_group_id]
Responses

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