Skip to main content
POST
تحديث Monitor

التفويضات

pubrio-api-key
string
header
مطلوب

رمز API فريد يمثّل الإجراءات التي تنفّذها عبر الواجهة والصلاحيات والعمليات المقابلة. يمكنك إنشاءه عبر قسم Settings.

الجسم

application/json
monitor_id
string<uuid>
مطلوب

المعرّف الفريد للـ Monitor المراد تحديثه.

name
string

اسم الـ Monitor.

description
string

وصف الـ Monitor.

detection_mode
enum<string>

كيفية اكتشاف الإشارات. يفحص signal_first السوق بشكل واسع؛ ويتتبع company_first قائمة حسابات مسمّاة ويتطلب شركة واحدة على الأقل، أو نطاقًا، أو رابط LinkedIn. غير قابل للتغيير بعد الإنشاء — تغييره في Monitor موجود يُعيد 40021. أنشئ Monitor جديدًا بدلًا من ذلك.

الخيارات المتاحة:
company_first,
signal_first
signal_types
enum<string>[]

أنواع الإشارات المراد مراقبتها.

الخيارات المتاحة:
jobs,
news,
advertisements,
expansions
signal_filters
object[]

إدخال واحد لكل دفق إشارة يراقبه الـ Monitor.

مثال:
company_filters
object

مرشحات شركة عامة مطبَّقة كطبقة ثانية عبر كل أنواع الإشارات. تقبل نفس معاملات نقطة Company Search — المواقع، عدد الموظفين، التقنيات، القطاعات، والمزيد.

مثال:
companies
string<uuid>[]

قائمة معرّفات domain_search_id (UUID) للشركات. البديل: استخدم domains أو linkedin_urls.

domains
string[]

قائمة نطاقات الشركات. بديل لـ companies.

linkedin_urls
string<uri>[]

قائمة روابط شركات على LinkedIn. بديل لـ companies.

is_company_enrichment
boolean

ما إذا كان سيتم إثراء بيانات الشركة.

is_people_enrichment
boolean

ما إذا كان سيتم إثراء بيانات الأشخاص.

people_enrichment_configs
object[]

مصفوفة من طبقات إثراء الأشخاص. تشغّل كل طبقة بحثًا مستقلًا عن الأشخاص. تحتوي max_people_to_return (1-25)، وpeople_contact_types (مصفوفة — تشير إلى أنواع بيانات تواصل Redeem: email-work، email-personal، phone)، وfilters (نفس معاملات نقطة People Search).

مثال:
destination_type
enum<string>

نوع وجهة التسليم.

الخيارات المتاحة:
webhook,
email,
sequences
destination_config
object

ضبط الوجهة. لـ webhook: يتطلب webhook_url (نص)، وheaders (كائن) وbody (كائن) اختياريان. للبريد الإلكتروني: يقبل email (نص) أو emails (مصفوفة نصوص). للتسلسلات: يتطلب sequence_identifier (نص) بالإضافة إلى واحد على الأقل من is_people_search_enrolled / is_company_contact_enrolled مضبوطًا على true.

مثال:
frequency_minute
integer

وتيرة التفعيل بالدقائق. الأدنى: 0، الأقصى: 10080، الافتراضي: 0.

النطاق المطلوب: 0 <= x <= 10080
max_failure_trigger
integer

الحد الأقصى للإخفاقات المتتالية قبل الإيقاف المؤقت. الأدنى: 1، الأقصى: 10، الافتراضي: 5.

النطاق المطلوب: 1 <= x <= 10
max_daily_trigger
integer

الحد الأقصى للتفعيلات يوميًا. الأدنى: 0، الأقصى: 86400، الافتراضي: 500.

النطاق المطلوب: 0 <= x <= 86400
max_records_per_trigger
integer

يتحكم في الحد الأقصى لعدد السجلات المُسلَّمة لكل تفعيل. القيم الأقل تقلل حجم الحمولة لكل تسليم، وهو موصى به لمجموعات النتائج الكبيرة أو التكاملات المحدودة المعدل. الأدنى: 1، الأقصى: 100، الافتراضي: 25. راجع إعداد Webhooks للإرشاد.

النطاق المطلوب: 1 <= x <= 100
notification_email
string<email>

البريد الإلكتروني لإشعارات الإخفاق.

max_retry_per_trigger
integer

الحد الأقصى لإعادة المحاولات لكل تفعيل. الأدنى: 0، الأقصى: 3، الافتراضي: 1.

النطاق المطلوب: 0 <= x <= 3
retry_delay_second
integer

التأخير بين إعادة المحاولات بالثواني. الأدنى: 1، الأقصى: 5، الافتراضي: 1.

النطاق المطلوب: 1 <= x <= 5
status
enum<string>

حالة دورة الحياة المراد ضبطها. تغيير الحالة يعيد ضبط عدّاد الإخفاق.

الخيارات المتاحة:
draft,
active,
paused,
inactive

الاستجابة

استجابة ناجحة تحتوي على الـ Monitor المُحدَّث. تتضمن الاستجابة دائمًا monitor_id، وname، وdetection_mode، وdestination_type، وstatus، وmasked_signature، وlast_modified، بالإضافة إلى أي أعمدة أخرى كانت جزءًا من التحديث.

data
object

الـ Monitor المُحدَّث. تُعاد أيضًا أي أعمدة أخرى مضمَّنة في التحديث.