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. Requires overlays:manage.

GET/overlays/{overlayId}/tip-goal

Authorization

AuthorizationBearer token (tp_live_...) · headerrequired

A TipPage API key, created in Dashboard → Settings → Developer.

Path parameters

overlayIdstringrequired

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

Responses

200The 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

401Missing or invalid API key (`missing_api_key` / `invalid_api_key`).

errorstringrequired

Human-readable message.

codestring

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

403The key lacks the required scope (`missing_scope`).

errorstringrequired

Human-readable message.

codestring

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

required_scopestring

404No such resource.

errorstringrequired

Human-readable message.

codestring

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

429Rate limit exceeded - check the `RateLimit-*` headers.

errorstring

Request

curl -X GET "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.tippage.com/v1/overlays/o_1a2b3c4d/tip-goal",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

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"
  }
}