Get an overlay's tip goal
The overlay’s tip goal campaign. current = tips received since the campaign start, plus any manual adjustments made through the add endpoint. A tip that is refunded or charged back stops counting, so current can go down. Requires overlays:manage.
/overlays/{overlayId}/tip-goalAuthorizationBearer token (tp_live_... or tpat_...) · headerrequiredA TipPage API key (tp_live_..., created in Dashboard → Settings → Developer) or an OAuth 2.0 access token (tpat_..., see the OAuth guide). Both carry the same scopes and are accepted on every endpoint.
overlayIdstringrequiredThe overlay's id (o_ + 8 hex chars).
The tip goal.
tip_goalTipGoalShow propertiesHide properties
enabledbooleantitlestringamountnumberThe target.
currentnumberTips since starts_at plus manual adjustments.
starts_atstring<date-time> | nullends_atstring<date-time> | nullMissing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
The key lacks the required scope (missing_scope).
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
required_scopestringNo such resource.
errorstringrequiredHuman-readable message.
codestringMachine-readable code (e.g. missing_scope, not_in_queue).
Rate limit exceeded - check the RateLimit-* headers.
errorstring