tipping

Get tipping overview

Returns an overview of all broadcasters that have received tips or have tipping enabled. The user must be authenticated as a privileged API user (is_staff must be true).

GET/tipping/overview

Query parameters

Header parameters

Response

200

200

Body

application/json

users*array of object

page*number

items_per_page*number

pages_total*number

items_total*number

Request

JavaScriptCurlPython

const response = await fetch('/tipping/overview', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "users": [
    {
      "id": "text",
      "username": "text",
      "paypal_email": "text",
      "paypal_currency": "text",
      "paypal_total_usd_amount": 0,
      "paypal_avg_usd_amount": 0,
      "paypal_total_num_tips": 0,
      "tipping_enabled": false
    }
  ],
  "page": 0,
  "items_per_page": 0,
  "pages_total": 0,
  "items_total": 0
}