Skip to main content
POST
إنشاء Monitor

التفويضات

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

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

الجسم

application/json
query
string
مطلوب

وصف باللغة الطبيعية للـ Monitor (بأي لغة)، مثل "راقب الشركات المتوسعة إلى اليابان، احصل على أشخاص من المستوى القيادي ببريد العمل الخاص بهم، وأرسل تنبيهات بريد إلكتروني إلى [email protected] في الوقت الفعلي". يُفسَّر إلى الحقول أدناه (detection_mode، signal_types، signal_filters، people_enrichment_configs، destination_type/destination_config، frequency_minute) ضمن نفس الطلب. أي حقل تمرره أيضًا صراحة يتجاوز القيمة المفسَّرة. إن لم يكن النص طلب Monitor، يُعيد الاستدعاء 400. محدود بـ2000 حرف.

Maximum string length: 2000
name
string

اسم الـ Monitor.

description
string

وصف الـ Monitor.

status
enum<string>
افتراضي:active

حالة دورة الحياة المراد إنشاء الـ Monitor بها. القيمة الافتراضية active. استخدم draft لحفظ Monitor نصف مكتمل: يُطلَب فقط name، ويُؤجَّل التحقق حتى تفعّله، ولا يعمل المسودة أبدًا.

الخيارات المتاحة:
draft,
active,
paused,
inactive
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) للشركات المراد مراقبتها. تُستخدَم أساسًا في وضع company_first لتحديد الشركات المستهدفة. يمكنك أيضًا استخدام domains أو linkedin_urls كبدائل — يُطلَب واحد فقط من الثلاثة.

domains
string[]

قائمة نطاقات الشركات المراد مراقبتها (مثل ["openai.com", "google.com"]). بديل لـ companies — يحل Pubrio هذه إلى الشركات المقابلة. يُطلَب واحد فقط من companies أو domains أو linkedin_urls.

linkedin_urls
string<uri>[]

قائمة روابط شركات على LinkedIn المراد مراقبتها (مثل ["https://linkedin.com/company/pubrio"]). بديل لـ companies — يحل Pubrio هذه إلى الشركات المقابلة. يُطلَب واحد فقط من companies أو domains أو linkedin_urls.

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

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

النطاق المطلوب: 0 <= x <= 10080
max_failure_trigger
integer
افتراضي:5

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

النطاق المطلوب: 1 <= x <= 10
max_daily_trigger
integer
افتراضي:500

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

النطاق المطلوب: 0 <= x <= 86400
max_records_per_trigger
integer
افتراضي:25

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

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

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

max_retry_per_trigger
integer
افتراضي:1

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

النطاق المطلوب: 0 <= x <= 3
retry_delay_second
integer
افتراضي:1

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

النطاق المطلوب: 1 <= x <= 5
deep
boolean

اختياري، يُستخدَم فقط مع query. شغّل تمريرة التفكير التأملي للحصول على دقة تفسير أعلى (الافتراضي true؛ يضاعف تقريبًا زمن التفسير). اضبطه على false لتمريرة واحدة أسرع.

الاستجابة

استجابة ناجحة تحتوي على تفاصيل الـ Monitor الذي أُنشئ حديثًا.

data
object