List invites and the joins each brought
/api/discord/invitesThe server's invites with their names and how many people joined through each, and the joins per source, per day, for the last days days (1 to 365, default 30). Invites with the same name are one source; the vanity link is its own; joins Modbot could not trace are Unknown. trackingOn is false while invite tracking is off. For somebody who may change settings it first reads the invites from Discord, which needs Manage Server, and says in readError when that failed.
Needs the ViewAnalytics permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
int32Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/discord/invites"{ "from": "2019-08-24", "to": "2019-08-24", "joins": 0, "sources": [ { "name": "string", "unknown": true, "invites": 0, "joinsInRange": 0, "joinsEver": 0 } ], "series": [ { "name": "string", "days": [ { "day": "2019-08-24", "value": 0.1 } ] } ], "invites": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "code": "string", "name": null, "source": "string", "isVanity": true, "madeByModbot": true, "gone": true, "joins": 0 } ], "readError": null, "missingPermission": true, "mostNameLength": 0, "mostCreatedAtOnce": 0, "trackingOn": true}Pause invites POST
Pause the Discord server's invites for 24 hours, the most Discord allows. Needs the gate to be on, Allow pausing invites, and Manage Server for the bot. Needs the `ManageJoinGate` permission.
Name an invite PUT
Set what the invite is called, or clear it with a null name. Invites with the same name are one source in the joins report. Past joins through it take the new name. Needs the `ManageSettings` permission.