Modbot Docs
APIAPI referenceDiscord

List invites and the joins each brought

GET/api/discord/invites

The 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.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

days?integer
Formatint32

Response 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}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.