Husqy API serverstats module

General

Endpoints related to general Husqy Modules Serverstats.

GET - /modules/serverstats/

Home endpoint for the Modules Serverstats Husqy API. Returns only success message displaying that it is the Modules Serverstats Husqy API route.

GET - /modules/serverstats/settings

Get the settings of the serverstats module for the specified guild.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to check the status of

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError

PUT - /modules/serverstats/settings

Endpoint to change the settings of the serverstats module for the specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to change the serverstats module settings for
counters_enabled	yes	`boolean`	If the counters should be enabled
counters_category_id	yes	`integer`	The ID of the category channel where the counters will be located. Can be 'create' to create a category
starboard_enabled	yes	`boolean`	If the starboard should be enabled
starboard_channel	yes	`integer`	The ID of the channel where the starboard messages will be sent. Can be 'create' to create a channel
starboard_count	yes	`integer`	The amount of stars required to get into the starboard channel
stats_messages_enabled	yes	`boolean`	If the message statistics should be enabled
stats_commands_enabled	yes	`boolean`	If the commands statistics should be enabled
stats_members_enabled	yes	`boolean`	If the members statistics should be enabled
stats_activities_enabled	yes	`boolean`	If the activities statistics should be enabled
stats_voice_enabled	yes	`boolean`	If the voice statistics should be enabled
stats_modules_autoresponder_enabled	yes	`boolean`	If the module autoresponder statistics should be enabled
stats_modules_tags_enabled	yes	`boolean`	If the module tags statistics should be enabled
stats_modules_verifier_enabled	yes	`boolean`	If the module verifier statistics should be enabled
stats_modules_socials_enabled	yes	`boolean`	If the module socials statistics should be enabled
stats_modules_rules_enabled	yes	`boolean`	If the module rules statistics should be enabled
stats_modules_invite_tracker_enabled	yes	`boolean`	If the module invite tracker statistics should be enabled
stats_modules_reactionroles_enabled	yes	`boolean`	If the module reactionroles statistics should be enabled
stats_modules_welcoming_enabled	yes	`boolean`	If the module welcoming statistics should be enabled
stats_modules_tempchannels_enabled	yes	`boolean`	If the module tempchannels statistics should be enabled
stats_modules_tickets_enabled	yes	`boolean`	If the module tickets statistics should be enabled
stats_functions_reminders_enabled	yes	`boolean`	If the function reminders statistics should be enabled
stats_functions_giveaways_enabled	yes	`boolean`	If the function giveaways statistics should be enabled

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
DatabaseError

DELETE - /modules/serverstats/settings/delete

Delete all settings of the serverstats module for a specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to delete the settings from

Possible errors:

BadRequestError

Status

Endpoints related to the status of the module

GET - /modules/serverstats/status

Get the status of the serverstats module for the specified guild.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to check the status of

Possible errors:

BadRequestError
SettingsError

POST - /modules/serverstats/enable

Endpoint to enable the serverstats module for the specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to enable the serverstats module for

Possible errors:

BadRequestError
SettingsError
ModuleEnabledError
DatabaseError

POST - /modules/serverstats/disable

Endpoint to disable the serverstats module for the specified guild.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to disable the serverstats module for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
DatabaseError
InternalServerError

Counters

Endpoints related to counters

GET - /modules/serverstats/counters

Endpoint to get all active counters in the server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to get the counters from
page	no	`integer`	The page number to get (default = 1)
page_size	no	`integer`	The amount of counters to return in one page (default = 10)

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError

POST - /modules/serverstats/counters

Endpoint to create a new counters in the server.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to create the new counters in
counter_type	yes	`integer`	The type of the counter to create. Can be 1 (for: Statuses), 2 (for: Online), 3 (for: Online with role), 4 (for: Offline), 5 (for: DND), 6 (for: Members), 7 (for: Members with role), 8 (for: Boost), 9 (for: Channels), 10 (for: Roles)
new_format	yes	`string`	The format to use for the counters
new_role_id	yes	`integer`	The ID for the role to use. Can be None when the type is not: 3 or 7
new_goal	yes	`integer`	The goal number to count towards. Can be None.

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
DatabaseError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

GET - /modules/serverstats/counter/{counter_id}

Endpoint to get information about a specific counter in the server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to get the counters from

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError

DELETE - /modules/serverstats/counter/{counter_id}

Endpoint to delete a specific counter in the server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to get the counters from

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
DatabaseError

POST - /modules/serverstats/counters/update

danger

Do not use this endpoint yourself! Husqy will update counters automatically.

Endpoint to start updating counters for all servers.

Possible errors:

InternalServerError

POST - /modules/serverstats/counters/check-delete

danger

Do not use this endpoint yourself! Husqy will update the configuration when a channel that is a counter panel channel is deleted.

Endpoint to check if a channel is a counters channel and update the configuration.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the removed channel is located
channel_id	yes	`integer`	The ID of the channel that is removed

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Starboard

Endpoints related to starboards

POST - /modules/serverstats/starboard/add

danger

Do not use this endpoint yourself! Starboard messages will be created by Husqy when needed.

Endpoint to check a message for sending to the starboard channel.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the possible starboard message is located
channel_id	yes	`integer`	The ID of the channel where the interacted message is located
message_id	yes	`integer`	The ID of the message which is the interacted message

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError

POST - /modules/serverstats/starboard/remove

danger

Do not use this endpoint yourself! Starboard messages will be removed by Husqy when needed.

Endpoint to check a message for sending to the starboard channel.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the possible starboard message is located
channel_id	yes	`integer`	The ID of the channel where the interacted message is located
message_id	yes	`integer`	The ID of the message which is the interacted message

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError

POST - /modules/serverstats/starboard/check/delete

danger

Do not use this endpoint yourself! Husqy will update the configuration when the starboard channel is deleted.

Endpoint to check if a channel is the starboard channel channel and update the configuration.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the removed channel is located
channel_id	yes	`integer`	The ID of the channel that is removed

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

POST - /modules/serverstats/starboard/check/deleted-message

danger

Do not use this endpoint yourself! Husqy will update the configuration when the starboard message is deleted.

Endpoint to check if a message is a starboard message and update the configuration.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the removed channel is located
message_id	yes	`integer`	The ID of the message that is removed

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Statistics

Endpoints related to statistics

note

Statistics GET endpoints will return a list of objects containing all information you need about the statistics.

Voice

GET - /modules/serverstats/stats/voice

Endpoint to get voice related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for
channel_id	no	`integer`	The ID of the channel to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/voice

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add voice related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
joined_member_id	yes	`integer`	The ID of the member that joined a voice channel
channel_id	yes	`integer`	The ID of the channel that the user has joined

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

PUT - /modules/serverstats/stats/voice

danger

Do not use this endpoint yourself! Husqy will update statistical data when appropriate.

Endpoint to update created (POST request) voice related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
left_member_id	yes	`integer`	The ID of the member that left a voice channel
channel_id	yes	`integer`	The ID of the channel that the user has left

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Messages

Deleted

GET - /modules/serverstats/stats/messages/deleted

Endpoint to get message deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for
channel_id	no	`integer`	The ID of the channel to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/messages/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add messages deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
author_id	yes	`integer`	The ID of the member that deleted a message
channel_id	yes	`integer`	The ID of the channel where the deleted message was located
message_id	yes	`integer`	The ID of the message that has been deleted

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Sent

GET - /modules/serverstats/stats/messages/sent

Endpoint to get message sent related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for
channel_id	no	`integer`	The ID of the channel to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/messages/sent

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add messages sent related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
author_id	yes	`integer`	The ID of the member that sent a message
channel_id	yes	`integer`	The ID of the channel where the message is sent
message_id	yes	`integer`	The ID of the message that has been sent

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Members

Joined

GET - /modules/serverstats/stats/members/joined

Endpoint to get members joined related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/members/joined

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add members joined related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
joined_member_id	yes	`integer`	The ID of the member that joined the server

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Left

GET - /modules/serverstats/stats/members/left

Endpoint to get members left related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/members/left

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add members left related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
left_member_id	yes	`integer`	The ID of the member that left the server

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Total

GET - /modules/serverstats/stats/members/total

Endpoint to get members total related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

Activities

Statuses

GET - /modules/serverstats/stats/activities/statuses

Endpoint to get activities statuses related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

Presence

GET - /modules/serverstats/stats/activities/presence

Endpoint to get activities presence related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/activities/presence

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add activities presence related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
presence_user_id	yes	`integer`	The ID of the member that has updated their status
activities	yes	`list`	A list of the current activities for the user (Activity is a json object containing: activity_type, name, details and state)

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Commands

GET - /modules/serverstats/stats/commands/used

Endpoint to get commands used related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/commands/used

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add commands used related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
initiator_id	yes	`integer`	The ID of the member that has used a Husqy command
command	yes	`string`	The command the user has used

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Functions

Reminders

GET - /modules/serverstats/stats/functions/reminders/created

Endpoint to get reminders created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/functions/reminders/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reminders created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the member that has created a reminder

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

GET - /modules/serverstats/stats/functions/reminders/deleted

Endpoint to get reminders deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/functions/reminders/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reminders deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the member that has deleted a reminder

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Giveaways

GET - /modules/serverstats/stats/functions/giveaways/created

Endpoint to get giveaways created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/functions/giveaways/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add giveaways created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the member that has created a giveaway

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

GET - /modules/serverstats/stats/functions/giveaways/deleted

Endpoint to get giveaways deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/functions/giveaways/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add giveaways deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the member that has deleted a giveaway

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

GET - /modules/serverstats/stats/functions/giveaways/responders

Endpoint to get giveaways responders related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/functions/giveaways/responders

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add giveaways responders related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
responding_user_id	yes	`integer`	The ID of the member that has responded to a giveaway
old_giveaway_id	yes	`string`	The ID of the giveaway that the user responded to

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Modules

Autoresponder

Responses created

GET - /modules/serverstats/stats/modules/autoresponder/responses/created

Endpoint to get autoresponder responses created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/responses/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder responses created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the member that has created an autoresponder response

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Responses deleted

GET - /modules/serverstats/stats/modules/autoresponder/responses/deleted

Endpoint to get autoresponder responses deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/responses/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder responses deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the member that has deleted an autoresponder response

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Triggers created

GET - /modules/serverstats/stats/modules/autoresponder/triggers/created

Endpoint to get autoresponder triggers created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/triggers/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder triggers created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the member that has created an autoresponder trigger

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Triggers deleted

GET - /modules/serverstats/stats/modules/autoresponder/triggers/deleted

Endpoint to get autoresponder triggers deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/triggers/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder triggers deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the member that has deleted an autoresponder trigger

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Triggers hit

GET - /modules/serverstats/stats/modules/autoresponder/triggers/hit

Endpoint to get autoresponder triggers hit related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/triggers/hit

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder triggers hit related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
triggering_user_id	yes	`integer`	The ID of the member that has triggered an autoresponder trigger
trigger_id	yes	`string`	The ID of the trigger that has been hit

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Check time

GET - /modules/serverstats/stats/modules/autoresponder/check-time

Endpoint to get autoresponder check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/autoresponder/check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add autoresponder check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The time it took to check if a trigger is hit

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Invite tracker

Invites created

GET - /modules/serverstats/stats/modules/invite_tracker/invite/created

Endpoint to get invite tracker invite created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/invite_tracker/invite/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add invite tracker invite created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created the invite

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Invites deleted

GET - /modules/serverstats/stats/modules/invite_tracker/invite/deleted

Endpoint to get invite tracker invite deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/invite_tracker/invite/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add invite tracker invite deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted the invite

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Reactionroles

Panels created

GET - /modules/serverstats/stats/modules/reactionroles/panels/created

Endpoint to get reactionroles panels created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/reactionroles/panels/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reactionroles panels created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created the reactionroles panel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Panels deleted

GET - /modules/serverstats/stats/modules/reactionroles/panels/deleted

Endpoint to get reactionroles panels deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/reactionroles/panels/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reactionroles panels deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted the reactionroles panel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Reactionroles added

GET - /modules/serverstats/stats/modules/reactionroles/reactionroles/added

Endpoint to get reactionroles reactionroles added related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/reactionroles/reactionroles/added

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reactionroles reactionroles added related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has added the reactionrole

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Reactionroles removed

GET - /modules/serverstats/stats/modules/reactionroles/reactionroles/removed

Endpoint to get reactionroles reactionroles removed related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/reactionroles/reactionroles/removed

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reactionroles reactionroles removed related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has removed the reactionrole

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Check time

GET - /modules/serverstats/stats/modules/reactionroles/check-time

Endpoint to get reactionroles check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/reactionroles/check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add reactionroles check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check a reactionrole reaction

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Rules

Rules added

GET - /modules/serverstats/stats/modules/rules/rule/added

Endpoint to get rules rule added related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/rules/rule/added

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add rules rule added related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has added the rule

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Rules removed

GET - /modules/serverstats/stats/modules/rules/rule/removed

Endpoint to get rules rule removed related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/rules/rule/removed

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add rules rule removed related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has removed the rule

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Check time

GET - /modules/serverstats/stats/modules/rules/check-time

Endpoint to get rules check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/rules/check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add rules check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check a rule accepted/denied interaction

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Socials

Entries added

GET - /modules/serverstats/stats/modules/socials/entries/added

Endpoint to get socials entries added related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/socials/entries/added

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add socials entries added related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has added the socials entry

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Entries removed

GET - /modules/serverstats/stats/modules/socials/entries/removed

Endpoint to get socials entries removed related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/socials/entries/removed

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add socials entries removed related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has removed the socials entry

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tempchannels

Creation channel created

GET - /modules/serverstats/stats/modules/tempchannels/creation-channels/created

Endpoint to get tempchannels creation channels created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tempchannels/creation-channels/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tempchannels creation channels created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created the creation channel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Creation channel deleted

GET - /modules/serverstats/stats/modules/tempchannels/creation-channels/deleted

Endpoint to get tempchannels creation channels deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tempchannels/creation-channels/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tempchannels creation channels deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted the creation channel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tempchannels created

GET - /modules/serverstats/stats/modules/tempchannels/tempchannels/created

Endpoint to get tempchannels tempchannels created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tempchannels/tempchannels/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tempchannels tempchannels created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has triggered the creation of a tempchannel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Created check time

GET - /modules/serverstats/stats/modules/tempchannels/created-check-time

Endpoint to get tempchannels created check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tempchannels/created-check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tempchannels created check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check and create a tempchannel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Deleted check time

GET - /modules/serverstats/stats/modules/tempchannels/deleted-check-time

Endpoint to get tempchannels deleted check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tempchannels/deleted-check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tempchannels deleted check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check and delete a tempchannel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tickets

Panels created

GET - /modules/serverstats/stats/modules/tickets/panels/created

Endpoint to get tickets panels created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/panels/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets panels created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created a tickets panel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Panels deleted

GET - /modules/serverstats/stats/modules/tickets/panels/deleted

Endpoint to get tickets panels deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/panels/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets panels deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted a tickets panel

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Ticket type added

GET - /modules/serverstats/stats/modules/tickets/types/added

Endpoint to get tickets types added related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/types/added

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets types added related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has added the ticket type

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Ticket type removed

GET - /modules/serverstats/stats/modules/tickets/types/removed

Endpoint to get tickets types removed related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/types/removed

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets types removed related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has removed the ticket type

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tickets created

GET - /modules/serverstats/stats/modules/tickets/created

Endpoint to get tickets created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created a ticket

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tickets deleted

GET - /modules/serverstats/stats/modules/tickets/deleted

Endpoint to get tickets deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted a ticket

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tickets closed

GET - /modules/serverstats/stats/modules/tickets/closed

Endpoint to get tickets closed related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/closed

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets closed related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has closed a ticket

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Tickets reopened

GET - /modules/serverstats/stats/modules/tickets/reopened

Endpoint to get tickets reopened related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/tickets/reopened

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add tickets reopened related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has reopened a ticket

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Verifier

Check time

GET - /modules/serverstats/stats/modules/verifier/check-time

Endpoint to get verifier check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/verifier/check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add verifier check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check a verification interaction

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Welcoming

Responses created

GET - /modules/serverstats/stats/modules/welcoming/responses/created

Endpoint to get welcoming responses created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/welcoming/responses/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add welcoming responses created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created the response

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Responses deleted

GET - /modules/serverstats/stats/modules/welcoming/responses/deleted

Endpoint to get welcoming responses deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/welcoming/responses/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add welcoming responses deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted the response

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Timedroles created

GET - /modules/serverstats/stats/modules/welcoming/timedroles/created

Endpoint to get welcoming timedroles created related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/welcoming/timedroles/created

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add welcoming timedroles created related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
creating_user_id	yes	`integer`	The ID of the user that has created the timedroles

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Timedroles deleted

GET - /modules/serverstats/stats/modules/welcoming/timedroles/deleted

Endpoint to get welcoming timedroles deleted related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30
user_id	no	`integer`	The ID of the user to filter the statistical data for

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/welcoming/timedroles/deleted

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add welcoming timedroles deleted related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
deleting_user_id	yes	`integer`	The ID of the user that has deleted the timedroles

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Check time

GET - /modules/serverstats/stats/modules/welcoming/check-time

Endpoint to get welcoming check time related statistical data in a server.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the statistical data is related to
days	no	`integer`	The number of days to return. Can be between 1 and 30

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError
InternalServerError
Unprocessable Entity

{
    "success": False,
    "data": {},
    "error": {
        "code": 422,
        "message": "Unprocessable Entity! {reason}",
    },
},

POST - /modules/serverstats/stats/modules/welcoming/check-time

danger

Do not use this endpoint yourself! Husqy will add statistical data when appropriate.

Endpoint to add welcoming check time related statistical data.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild where the event has taken place
check_time	yes	`float`	The amount of time it took to check a welcoming event

Possible errors:

BadRequestError
SettingsError
ModuleDisabledError

Privacy

Endpoints related to privacy and the tags module

GET - /modules/serverstats/privacy/get-user-entries

danger

Do not use this endpoint yourself! This endpoint will be used by Husqy's Privacy configurator (/privacy) command.

Endpoint to get the amount of references in serverstats to your user.

Query string parameters:

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to get the specified references in
privacy_member_id	yes	`integer`	The ID of the member who wants to check their references

Possible errors:

BadRequestError
ForbiddenError
InternalServerError

DELETE - /modules/serverstats/privacy/delete-user-entries

danger

Do not use this endpoint yourself! This endpoint will be used by Husqy's Privacy configurator (/privacy) command.

Endpoint to delete the references in serverstats to your user.

Body data (JSON):

field	required	type	description
guild_id	yes	`integer`	The ID of the guild to delete the specified references in
privacy_member_id	yes	`integer`	The ID of the member who wants to remove their references

Possible errors:

BadRequestError
ForbiddenError
InternalServerError

General​

Status​

Counters​

Starboard​

Statistics​

Voice​

Messages​

Deleted​

Sent​

Members​

Joined​

Left​

Total​

Activities​

Statuses​

Presence​

Commands​

Functions​

Reminders​

Giveaways​

Modules​

Autoresponder​

Responses created​

Responses deleted​

Triggers created​

Triggers deleted​

Triggers hit​

Check time​

Invite tracker​

Invites created​

Invites deleted​

Reactionroles​

Panels created​

Panels deleted​

Reactionroles added​

Reactionroles removed​

Check time​

Rules​

Rules added​

Rules removed​

Check time​

Socials​

Entries added​

Entries removed​

Tags​

Tag created​

Tag deleted​

Check time​

Tempchannels​

Creation channel created​

Creation channel deleted​

Tempchannels created​

Created check time​

Deleted check time​

Tickets​

Panels created​

Panels deleted​

Ticket type added​

Ticket type removed​

Tickets created​

Tickets deleted​

Tickets closed​

Tickets reopened​

Verifier​

Check time​

Welcoming​

Responses created​

Responses deleted​

Timedroles created​

Timedroles deleted​

Check time​

Privacy​

General

Status

Counters

Starboard

Statistics

Voice

Messages

Deleted

Sent

Members

Joined

Left

Total

Activities

Statuses

Presence

Commands

Functions

Reminders

Giveaways

Modules

Autoresponder

Responses created

Responses deleted

Triggers created

Triggers deleted

Triggers hit

Check time

Invite tracker

Invites created

Invites deleted

Reactionroles

Panels created

Panels deleted

Reactionroles added

Reactionroles removed

Check time

Rules

Rules added

Rules removed

Check time

Socials

Entries added

Entries removed

Tags

Tag created

Tag deleted

Check time

Tempchannels

Creation channel created

Creation channel deleted

Tempchannels created

Created check time

Deleted check time

Tickets

Panels created

Panels deleted

Ticket type added

Ticket type removed

Tickets created

Tickets deleted

Tickets closed

Tickets reopened

Verifier

Check time

Welcoming

Responses created

Responses deleted

Timedroles created

Timedroles deleted

Check time

Privacy