Preview giveaway rules
POST
/api/giveaways/previewHow many people match a rule tree right now, and the first page of them. Figures counted from presence reports are close rather than exact; fromPolledData says when that is so, and closeCalls counts the people near a threshold. A rule reaching further back than the facts Modbot still keeps comes back in unanswerable instead of an answer.
Needs the RunGiveaways permission.
AuthorizationBearer <token>
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/giveaways/preview" \ -H "Content-Type: application/json" \ -d '{ "rules": null, "exclusions": null, "weighting": null, "weightCap": null, "entryWay": null }'{ "total": 0, "inDraw": 0, "totalWeight": 0, "closeCalls": 0, "fromPolledData": true, "unanswerable": null, "stopped": true, "people": [ { "position": 0, "key": "string", "vrChatUserId": null, "discordUserId": null, "name": null, "weight": 0, "measured": 0.1, "keptOut": "string", "keptOutLabel": "string", "because": null, "fromPolledData": true, "closeCall": true, "winnerRank": null, "purged": true } ]}