این API به شما امکان می‌دهد تا لیست کاربرانی که یک سرور خاص را بوست کرده‌اند را دریافت کنید. دسترسی به این API نیاز به احراز هویت دارد و تنها کاربران مجاز می‌توانند به اطلاعات بوست‌ها دسترسی داشته باشند. با استفاده از این API می‌توانید بوست‌هایی که کاربران برای سرور ثبت کرده‌اند را مشاهده کنید.
این endpoint لیست بوست‌های کاربران برای یک سرور خاص را برمی‌گرداند.
در صورت داشتن
?در کنار نوع داده، این مقدار می‌تواند خالی باشد.
| پارامتر | نوع داده | توضیحات |
|---|---|---|
category | string | دسته‌بندی سرور. |
serverName | string | نام سرور مورد نظر برای دریافت لیست بوست‌ها. |
query | string? | جستجوی کاربران بر اساس نام کاربری دیسکورد، discordId یا displayName. |
page | number? | شماره صفحه برای پشتیبانی از pagination. |
perPage | number? | تعداد بوست‌ها در هر صفحه. |
authorization | string | توکن احراز هویت برای دسترسی به این API که باید در هدر authorization قرار گیرد. |
احراز هویت: این API نیاز به توکن احراز هویت دارد که باید از طریق هدر authorization ارسال شود. در صورت نداشتن یا نامعتبر بودن توکن، دسترسی به اطلاعات بوست‌دهندگان امکان‌پذیر نخواهد بود.
پشتیبانی از پارامترهای اختیاری: با استفاده از پارامترهای query، page و perPage می‌توانید لیست بوست‌ها را مدیریت کنید.
برای دریافت توکن وارد پنل کاربری سرور خود شوید و از بخش تنظیمات توکن احراز هویت را دریافت کنید. (فقط Owner سرور دسترسی به توکن را دارد)
لیستی از بوست‌های کاربران برای سرور مورد نظر به صورت زیر برگردانده می‌شود:
| کلید | نوع داده | توضیحات |
|---|---|---|
boostedAt | string | تاریخ ثبت بوست توسط کاربر |
discordId | string | شناسه دیسکورد کاربر بوست‌دهنده |
displayName | string | نام نمایشی کاربر بوست‌دهنده |
username | string | نام کاربری دیسکورد کاربر بوست‌دهنده |
avatar | string | لینک آواتار دیسکورد کاربر بوست‌دهنده |
مدت زمان اعتبار بوست‌ها: بوست‌های هر کاربر برای مدت ۱ ماه فعال هستند و پس از آن منقضی می‌شوند. با استفاده از تاریخ
boostedAtو مقایسه آن با تاریخ فعلی، می‌توانید زمان انقضای هر بوست را محاسبه کنید.