Get Clients At Risk From Goal Health

Retrieve account- or client-scoped clients flagged as at risk from goal health (severity from the worst goal status present), most severe first, each with a severity and a short reason.

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 list is calculated for the authenticated account.

string
^(eq|in):.+$

Narrows clients at risk 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. Accepted for a uniform
filter contract; clients-at-risk is goal-health based and is not narrowed by the
date range (only the client scope applies).

filter[created_at]
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