tips

/:channel

Changed on Feb 8, 2021

List tips

get/tips/{channel}

Request

Base URL
https://api.streamelements.com/kappa/v2
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://api.streamelements.com/oauth2/authorize
  Token URLhttps://api.streamelements.com/oauth2/token
- or HTTP bearer
TypeScript
https://skmtc.dev/streamelements/apis/se-api-docs/docs/tips/:channel/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelstring required

Example:5b2e2007760aeb7729487dab

guid - Channel id

Query parameters

offsetinteger required

integer - Starting element

limitinteger required

Example:25

integer - Events per page between 1 and 100

sortstring required

Example:-createdAt

string - Sorting method. Possible values createdAt, -createdAt, donation.amount, -donation.amount, donation.provider, -donation.provider

tzinteger required

Example:4

integer - Timezone number

usernamestring required

string - Username

emailstring required

string - Email address

afterinteger required

datetime - Start date

beforeinteger required

Example:1544178274000

datetime - End date

messagestring required

string - Tip message

Response

providerstring required

statusstring required

deletedboolean required

_idstring required

channelstring required

transactionIdstring required

createdAtstring required

approvedstring required

updatedAtstring required

Example response

{
  "donation": {
    "user": {
      "username": "StreamElements",
      "geo": null,
      "email": "streamelements@streamelements.com"
    },
    "message": "This is a test",
    "amount": 100,
    "currency": "USD"
  },
  "provider": "paypal",
  "status": "success",
  "deleted": false,
  "_id": "5c0aab85de9a4c6756a14e0d",
  "channel": "5b2e2007760aeb7729487dab",
  "transactionId": "IMPORTED",
  "createdAt": "2018-12-07T17:19:01.957Z",
  "approved": "allowed",
  "updatedAt": "2018-12-07T17:19:01.957Z"
}

Changes

Feb 8, 2021fb6ec574b6a7 Revision changes
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Feb 8, 20218421cd25897f Revision changes
- info
  added the optional property //// to the response with the status

Operation history (3 revisions)