Get one overlay

One overlay, plus the widget types currently on its layout. Requires overlays:manage.

GET/overlays/{overlayId}

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

overlayobject

Show properties

idstring

namestring

resolutionobject

The overlay's fixed canvas resolution in pixels.

Show properties

widthinteger

heightinteger

created_atstring<date-time>

updated_atstring<date-time>

widgetsstring[]

Widget types on the layout.

celebrationsobject[]

Placed Event celebration widget instances - their ids target POST .../celebrate at one specific widget.

Show properties

Array of object

idstring

namestring | 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" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

import requests

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

Response

{
  "overlay": {
    "id": "o_1a2b3c4d",
    "name": "Main overlay",
    "resolution": {
      "width": 1920,
      "height": 1080
    },
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "widgets": [
      "alert",
      "chat",
      "celebration"
    ],
    "celebrations": [
      {
        "id": "celebration-mt9x2ab",
        "name": "Goal zone"
      }
    ]
  }
}