دسته‌بندی GET {BASE_URL}/searchapi/api/v{version}/search/catalogs/{catalogId}/documents/aggregations
توضیح
این API از لحاظ پارامترهای ورودی و محتوای خروجی مشابه API جستجو می‌باشد، با این تفاوت که حاوی پارامتری برای جستجوی عبارت نمی‌باشد. همان فیلترها و پارامترهای مرتب‌سازی را دریافت کرده و همه دسته‌بندی ها و داکیومنتهای موجود در آنها را باز می‌گرداند. در صورتی که فیلتر خاصی به عنوان پارامتر، به این API ارسال نشود حداکثر 10000 داکیومنت موجود به عنوان خروجی نمایش داده می‌شوند. استفاده از پیشفرض مرتب سازی، یا ارسال پارامتر مرتب سازی به این API می‌تواند در ترتیب نحوه نمایش تاثیرگذار باشد. باید توجه داشت که استفاده از این API نیز منجر به ثبت رکورد در لاگ عملیات خواهد شد.
پارامترها
| ردیف | پارامتر | پیشفرض | توضیحات | ضروری | نوع |
| ۱ | catalogId | ندارد | شناسه اختصاصی کاتالوگ مورد نظر | بله | رشته |
| ۲ | facets | [ ] | فیلترهای مرتبط با مقادیر دسته‌بندی‌های ثابت | خیر | آرایه |
| ۳ | relevantfacets | [ ] | فیلترهای مرتبط با مقادیر دسته‌بندی‌های پویا | خیر | آرایه |
| ۴ | sorts | [ ] | تنظیمات مرتبط با نحوه مرتب سازی | خیر | آرایه |
| ۵ | PageSize | ۱۰ | حداکثر تعداد داکیومنتهای نمایش داده شده در هر درخواست | خیر | عدد صحیح |
| ۶ | Offset | ۱ | آفست مربوط به داکیومنت ابتدایی هر درخواست | خیر | عدد صحیح |
کدهای خطا
| ردیف | کد خطا | توضیحات |
| ۱ | ۴۰۰ | در صورتی که ساختار هر یک از مقادیر به صورت اشتباه به API فرستاده شده باشد. |
| ۲ | ۴۰۴ | در صورتی که شناسه کاتالوگ صحیح نباشد. |