Get Goals Aggregate (v1.2)

Provides a goals dashboard for an employee: goals matching the selected filter, status filter counts/actions, comment counts, and people shared with or commenting on those goals. This v1.2 endpoint includes milestone-based goals in the returned goal list. Use the optional filter query parameter to control which statuses are included; use status-all when the user asks for a complete dashboard across active, completed, and closed goals. Note: Compared to "Get Goals Aggregate (v1.1)", this version returns goals that contain milestones.

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

employeeId is the employee ID used to generate the aggregate information.

Query Params
string

Optional status filter for the goals collection in the aggregate response. Use status-all for a full dashboard across statuses; otherwise pass status-inProgress, status-completed, or status-closed. If omitted or invalid, defaults to the first available filter. The response's filters counts may include statuses beyond the selected goal list.

Responses

403

The API user does not have permission to view goals for this employee.

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