Skip to content
TipPage Docs
Esc
↑↓navigate↵open⌘Jpreview

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.

GET/overlays/{overlayId}/tip-goal
Authorization
AuthorizationBearer token (tp_live_... or tpat_...) · headerrequired

A 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.

Path parameters
overlayIdstringrequired

The overlay's id (o_ + 8 hex chars).

Responses
200

The tip goal.

tip_goalTipGoal
Show properties
enabledboolean
titlestring
amountnumber

The target.

currentnumber

Tips since starts_at plus manual adjustments.

starts_atstring<date-time> | null
ends_atstring<date-time> | null
401

Missing or invalid credential (missing_api_key / invalid_api_key, or invalid_token for an expired/revoked OAuth access token).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

403

The key lacks the required scope (missing_scope).

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

required_scopestring
404

No such resource.

errorstringrequired

Human-readable message.

codestring

Machine-readable code (e.g. missing_scope, not_in_queue).

429

Rate limit exceeded - check the RateLimit-* headers.

errorstring
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "tip_goal": {
    "enabled": true,
    "title": "New PC fund",
    "amount": 500,
    "current": 173.5,
    "starts_at": "2019-08-24T14:15:22Z",
    "ends_at": "2019-08-24T14:15:22Z"
  }
}