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

Alert history

Platform alerts, newest first. By default the finished ones: every alert the overlay played or that was skipped. With status=all, every platform event as it happened - those still waiting for an overlay (waiting), those the live alert box never showed because the type is off or under its minimum (not_played), and every channel-point redemption, whether or not a box alerted on it (a redemption that never alerted is a channel_points row whose id is Twitch’s redemption id, status not_played, nothing to replay). A tip-filter-blocked alert is never listed. limit up to 200. Requires tts:read.

GET/alerts/history
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.
Query parameters
limitinteger
min 1 · max 200 · default: 50
statusstring
`all` = every platform event, not only the finished ones.
default: "finished"
Allowed:finishedall
beforestring<date-time>
Cursor - a `happened_at` from a previous page (`next_cursor`). Returns rows strictly older than it.
Responses
200One page of alerts.
alertsAlert[]
Show properties
Array of Alert
idstring
`ev_...` - the event id the webhooks carry.
typestring
Allowed:followsubscriptiongift_subscriptioncheerraidkickschannel_points
event_typestring | null
The payload type (`channel.subscription.message` tells a resub from a sub).
platformstring
Allowed:twitchkick
namestring
Who it was from.
profile_image_urlstring | null
tierstring | null
Twitch tier id (`1000`, `2000`, `3000`); `1` on Kick.
totalinteger | null
Gift subs - how many.
bitsinteger | null
viewersinteger | null
Raids.
kicksinteger | null
monthsinteger | null
Resubs.
messagestring | null
The viewer's own text
reward_titlestring | null
Channel point redemptions.
reward_costinteger | null
Channel point redemptions - the reward's cost in points.
redemption_idstring | null
Channel point redemptions - Twitch's id of the redemption.
gift_recipientsstring[]
Gifted subs - who received them, as Twitch's gift notices named them. Empty when none were caught (a gift whose notices never arrived, an older row).
statusstring
`waiting` and `not_played` only appear with `status=all`.
Allowed:playedskippedwaitingnot_played
is_replayboolean
replay_ofstring | null
The original's id when this was a replay.
happened_atstring<date-time>
finished_atstring<date-time> | null
When it left the screen.
has_moreboolean
next_cursorstring | null
Pass as `?before=` to fetch the next page.
401Missing 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`).
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
429Rate limit exceeded - check the `RateLimit-*` headers.
errorstring
Request
curl -X GET "https://api.tippage.com/v1/alerts/history" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "alerts": [
    {
      "id": "string",
      "type": "follow",
      "event_type": "string",
      "platform": "twitch",
      "name": "string",
      "profile_image_url": "string",
      "tier": "string",
      "total": 0,
      "bits": 0,
      "viewers": 0,
      "kicks": 0,
      "months": 0,
      "message": "string",
      "reward_title": "string",
      "reward_cost": 0,
      "redemption_id": "string",
      "gift_recipients": [
        "string"
      ],
      "status": "played",
      "is_replay": true,
      "replay_of": "string",
      "happened_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}