مستندات وب‌سرویس سرآور
ورود به داشبورد

مرجع api / leads/fields/

فهرست فیلدهای قابل فیلتر

تمام فیلدهای پشتیبانی‌شده برای ساخت فیلتر در اندپوینت‌های دیگر را برمی‌گرداند. این اندپوینت رایگان است و معمولاً ابتدای جریان شما برای ساخت رابط کاربری فیلترسازی فراخوانی می‌شود.

GETleads/fields/

فهرست تمام فیلدهای پشتیبانی‌شده برای ساخت فیلتر در endpoint های leads/get-count/ و leads/get-records/ را برمی‌گرداند. این endpoint رایگان است و معمولاً ابتدای جریان کار شما برای ساخت رابط کاربری فیلترسازی فراخوانی می‌شود.

رایگان20 درخواست در دقیقه

هدرها

X-API-KEYstringبله

کلید api شما. به صورت جایگزین می‌توانید از Authorization: Api-Key <key> استفاده کنید.

نمونه درخواست

curl -X GET 'https://saravar.com/api/leads/fields/' \
  -H 'X-API-KEY: <YOUR_API_KEY>'

پاسخ

keystringبله

شناسه فنی فیلد، در فیلتر استفاده می‌شود.

field_typestringبله

نوع فیلد: "category" (لیست انتخابی، نیاز به فراخوانی leads/categories/)، "date"، "number"، یا "string".

descriptionstringبله

توضیح فارسی فیلد، مناسب نمایش در رابط کاربری.

supported_operandsstring[]بله

فهرست عملگرهای مجاز برای این فیلد (مثل equals، in، greater_than، less_than، between، …).

خطاها

401کد وضعیت
علتهدر X-API-KEY مفقود است یا کلید نامعتبر/ابطال‌شده است.
اقدام پیشنهادیکلید فعال در داشبورد بسازید و در درخواست خود ارسال کنید.
429کد وضعیت
علتاز سقف ۲۰ درخواست در دقیقه برای این کلید عبور کرده‌اید.
اقدام پیشنهادیتا انقضای هدر Retry-After صبر کنید و مجدداً تلاش کنید.