این 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 سرور دسترسی به توکن را دارد)
لیستی از رای‌های کاربران به سرور مورد نظر به صورت زیر برگردانده می‌شود:
| کلید | نوع داده | توضیحات |
|---|---|---|
votedAt | string | تاریخ ثبت رای توسط کاربر |
discordId | string | شناسه دیسکورد رای‌دهنده |
displayName | string | نام نمایشی رای‌دهنده |
username | string | نام کاربری دیسکورد رای‌دهنده |
avatar | string | لینک آواتار دیسکورد رای‌دهنده |