Get Goal Settings
GET/api/advertising/goals/settings
Returns the tenant's goal mode. suggest (default): the goal advisor only creates suggestions that a person accepts or dismisses. auto: open suggestions are applied automatically on the nightly advisor run, each switch recorded with its reason.
advertising:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires the advertising.view permission; the tenant must have the advertising-manager feature enabled.
The response also returns dismissal_suppression_days: how many days a dismissed goal suggestion is not offered again for the same product and goal (14 by default).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.