- Queries grants by event and channel, with optional member filter and paging.
Path
Headers
| Field | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Token we provide |
Request parameters
| Field | Type | Required | Signed | Description |
|---|---|---|---|---|
channelID | number | Yes | ✓ | Channel ID (use 1 if you have no channels) |
eventID | string | Yes | ✓ | Event ID (24-character hex) |
memberAccount | string | No | ✓ | Member account (allowed characters: a-z A-Z 0-9 _-) |
nextToken | string | No | ✓ | Query token (empty on the first query, then the nextToken from the previous result) |
maxResults | number | Yes | ✓ | Maximum number of results (min 2000, max 5000) |
sign | string | Yes | Signature. See Signature for how to generate it |
Response
Success (the HTTP status code is always 200; checkstatus.code for the result)
| Field | Type | Description |
|---|---|---|
data | object | |
data.grantList | object[] | Grants |
data.grantList[].eventID | string | Event ID |
data.grantList[].grantID | string | Grant ID |
data.grantList[].channelID | number | Channel ID |
data.grantList[].memberAccount | string | Member account |
data.grantList[].status | string | Status (New / Active / Completed / Freeze / Expired / SettleFailed) |
data.grantList[].totalSpinTimes | number | Free spins given when granted |
data.grantList[].usedSpinTimes | number | Spins used |
data.grantList[].paidAmount | number | Total payout credited to the wallet |
data.grantList[].paidCount | number | Number of payouts |
data.grantList[].grantedAt | string | Grant creation time (see Time format) |
data.grantList[].completedAt | string | Completion time, empty if not completed (see Time format) |
data.grantList[].frozenAt | string | Freeze time, empty if not frozen (see Time format) |
data.grantList[].expiredAt | string | Expiry time (see Time format) |
data.nextToken | string | Token for the next query (empty string on the last page) |
data.maxResults | number | Maximum number of results returned |
data.total | number | Total number of records in this query |
status | object | Response status. See Response format |