Community Support System API

Below, you'll find all endpoints needed to fetch some data about the ticket system on a guild.

GET

Get statistics

https://yunite.xyz/api/v3/guild/{guildId}/acss/stats

Request

Path Parameters

Name	Value type	Description
guildId	Guild ID Snowflake	The ID of the guild you want to access

Query Parameters

Name	Value type	Description
from	UNIX-timestamp (= seconds since epoch)	Timestamp of the start of the period you want to get statistics for; optional - omit if you want to go back as far as possible
to	UNIX-timestamp (= seconds since epoch)	Timestamp of the end of the period you want to get statistics for; optional - omit if you want to get stats up until right now

Response

Schema

{
    "type": "array",
    "itemSchema": {
        "type": "object",
        "properties": {
            "ticketsOpenedInThisPeriod": {
                "type": "object",
                "properties": {
                    "OPEN": {
                        "type": "int",
                        "value": "number of tickets that were opened in the given time period, and are not being worked on yet"
                    },
                    "WAITING_FOR_SUPPORT_REPLY": {
                        "type": "int",
                        "value": "number of tickets that were opened in the given time period, and currently waiting for the supporter to answer"
                    },
                    "WAITING_FOR_USER_REPLY": {
                        "type": "int",
                        "value": "number of tickets that were opened in the given time period, and waiting for a user response"
                    },
                    "MARKED_AS_RESOLVED_BY_USER": {
                        "type": "int",
                        "value": "number of tickets that were opened in the given time period, and are marked as resolved by the user"
                    },
                    "CLOSED_BY_SUPPORTER": {
                        "type": "int",
                        "value": "number of tickets that were opened in the given time period, and have been closed"
                    }
                }
            },
            "staffTicketClosedStatistics": {
                "type": "object",
                "properties": {
                    "123": {
                        "type": "int",
                        "value": "number of tickets closed by user with id 123"
                    },
                    "456": {
                        "type": "int",
                        "value": "number of tickets closed by user with id 456"
                    },
                    "...": {
                        "type": "... and so on"
                    }
                }
            }
        }
    }
}

Example

[
    {
        "ticketsOpenedInThisPeriod": {
            "OPEN": 10,
            "WAITING_FOR_SUPPORT_REPLY": 20,
            "WAITING_FOR_USER_REPLY": 15,
            "MARKED_AS_RESOLVED_BY_USER": 3,
            "CLOSED_BY_SUPPORTER": 34
        },
        "staffTicketClosedStatistics": {
            "4759384923891023": 43,
            "3849572938492933": 12,
            "3489750304829879": 76
        }
    }
]