Synup
Create a key
v1Resources/Profile Analytics/putSet a client's report goals

Set a client's report goals

Choose which of the client's website goals count as website actions on Reports, and what kind each is. Send only the goals to change, with names exactly as the GET returns them. A goal the client's sources don't report returns 400. Returns the client's goals as they now stand, and the change applies to website actions in every period.

put/api/v1/clients/{id}/report-goals
clients:write
Query parameters
idstringrequired
The client's id.
Request body
goalsarray of objectrequired
providerstring (ga4 | plausible | posthog)required
namestringrequired
countedbooleanrequired
kindstring (form | call | booking | other)required
Response
dataarray of objectoptional
providerstring (ga4 | plausible | posthog)optional
namestringoptional
countedbooleanoptional
kindstring (form | call | booking | other)optional
custombooleanoptional
last12Weeksnumberoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
put/api/v1/clients/{id}/report-goals
Your API key
id *
Request body*
{}

Guides that use this resource