v0.2.0-beta

OpenAPI 3.1.0

הגדרת משימות Lighthouse

Felo API Support

MIT

שרת

https://openapi.felo.ai

ספריות לקוח

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO פעולות

post/v1/beta/dataforseo/on_page/lighthouse/task_post

הגדרת משימות Lighthouse

מכניס בדיקת Lighthouse לתור במקום להמתין לה, ומחזיר id של משימה. השתמשו בו כשהבדיקה תארך יותר מהסבלנות של קריאת כלי אחת; אחזרו עם get_dataforseo_on_page_lighthouse_task_get_json, וראו מה מוכן עם get_dataforseo_on_page_lighthouse_ready. התגובה עטופה במעטפת של DataForSEO: הנתונים ב-tasks[0].result, והתוצאה ב-tasks[0].status_code — גם בקשה שנדחתה מחזירה HTTP 200. ⚠️ אותו דוח של 245 KB בסוף, כך שעלות ההקשר נדחית ולא נמנעת — צמצמו אותו עם categories או audits כאן, לא אחר כך.

מראה תמחור

מדידה: עלות תגובה מדווחת.
אומדן בקשת ייחוס: 0.0051 דולר ארה״ב.
מכפיל לקוח לייחוס: 1.0. אין להחיל אותו בשנית על סכום לקוח שכבר נקבע.

זהו מטא-נתון לעיון בלבד, לא הצעת מחיר לחשבון, לא מחיר מובטח ולא תקרת הוצאה. קרדיטי משאבים אינם קרדיטים של Felo. החיוב הסופי נעשה לפי רשומות החיוב של Felo.

גוף

application/json

סוג: array (object | null)[]
- audits
  סוג: array string[] | null
  
  ביקורות Lighthouse
  שדה אופציונלי
  ביקורות הן בדיקות בודדות ש-Lighthouse מריץ עבור כל תכונה/אופטימיזציה/מדד ספציפי כדי להפיק ציון מספרי (ראו את ההגדרה הרשמית)אם מתעלמים מהשדה הזה, נחזיר נתונים עבור כל הביקורות
  השתמשו בשדה הזה כדי לקבל נתונים עבור הביקורות הספציפיות שמציינים כאן
  
  הערה שביקורות מסוימות אינן שייכות לקטגוריה ספציפית והן מדידות עצמאיות של איכות העמוד
  
  באופן כללי, ייתכנו כמה תרחישי שימוש:
  
  1. אם מתעלמים מ-categories, אפשר להשתמש בשדה הזה כדי לקבל נתונים רק עבור הביקורות שצוינו
  לדוגמה, אם מתעלמים מ-"categories" ומציינים "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], תקבלו נתונים רק עבור הביקורות האלה
  
  2. אם מציינים קטגוריה, אפשר להשתמש בשדה הזה כדי לקבל בנוסף ביקורות שאינן שייכות לקטגוריה (או הקטגוריות) שציינתם
  לדוגמה, אם מציינים "categories": ["seo"] ו-"audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], תקבלו רק את הביקורות האלה תחת "performance" ואת כל הביקורות תחת "seo"
  
  אפשר לקבל את הרשימה המלאה של הביקורות האפשריות כאן
- browser_cpu_throttling_multiplier
  סוג: number | null
  
  מכפיל הגבלת CPU בדפדפן
  חובה אם browser_network_throttling_method מוגדר ל-devtools;
  הגדירו את מכפיל הגבלת ה-CPU כדי לדמות תנאי ביצועים של מכשיר במהלך ביקורת Lighthouse;
  אפשר לציין אותו בטווח הבא: 1–4;
  הערה: הפרמטר הזה מוחל רק כאשר browser_network_throttling_method מוגדר ל-devtools;
- browser_network_throttling
  סוג: string | null
  
  הגבלת רשת הדפדפן
  חובה אם browser_network_throttling_method מוגדר ל-devtools;
  הגדירו את פרופיל הגבלת הרשת כדי לדמות תנאי מהירות חיבור במהלך ביקורת Lighthouse;
  ערכים אפשריים: no_throttling, fast_4g, slow_4g, regular_3g, pc;
  הערה: הפרמטר הזה מוחל רק כאשר browser_network_throttling_method מוגדר ל-devtools;
- browser_network_throttling_method
  סוג: string | null
  
  שיטת הגבלת רשת הדפדפן
  שדה אופציונלי
  מגדיר את השיטה להחלת הגבלה במהלך ביקורת Lighthouse;
  ערכים אפשריים:
  simulate - מחשב מדדי ביצועים משוערים בלי להחיל הגבלה מפורשת;
  devtools - מחיל את הגדרות ההגבלה שצוינו ב-browser_network_throttling וב-browser_cpu_throttling_multiplier;
  provided - משתמש בתנאי הרשת של סביבת הסריקה;
- browser_screen_height
  סוג: integer | null
  
  גובה מסך הדפדפן
  שדה אופציונלי
  הגדירו את גובה המסך של הדפדפן שבו משתמשים בביקורת Lighthouse כדי לדמות מכשיר מסוים;
  אפשר לציין אותו בטווח הבא: 240–9999;
- browser_screen_scale_factor
  סוג: number | null
  
  מקדם קנה מידה של מסך הדפדפן
  שדה אופציונלי
  הגדירו את יחס הפיקסלים של המכשיר בדפדפן שבו משתמשים בביקורת Lighthouse;
  אפשר לציין אותו בטווח הבא: 0.5–3;
- browser_screen_width
  סוג: integer | null פורמט: int64
  
  רוחב מסך הדפדפן
  שדה אופציונלי
  הגדירו את רוחב המסך של הדפדפן שבו משתמשים בביקורת Lighthouse כדי לדמות מכשיר מסוים;
  אפשר לציין אותו בטווח הבא: 240–9999;
- categories
  סוג: array string[] | null
  
  קטגוריות של ביקורות Lighthouse
  שדה אופציונלי
  כל קטגוריה היא אוסף של ביקורות וקבוצות ביקורת שמחיל שקלול וניקוד על הקטע (ראו את ההגדרה הרשמית)אם מתעלמים מהשדה הזה, נחזיר נתונים עבור כל הקטגוריות אלא אם מציינים audits
  השתמשו בשדה הזה כדי לקבל נתונים עבור קטגוריות ספציפיות שמציינים כאן
  
  ערכים אפשריים:
  seo, performance, best_practices, accessibility
- custom_user_agent
  סוג: string | null
  
  user agent מותאם אישית
  שדה אופציונלי
  ציינו את ה-user agent המותאם שבו משתמש הדפדפן בעת הפעלת ביקורת Lighthouse;
  אפשר לציין עד 254 תווים;
- for_mobile
  סוג: boolean | null
  
  החלת אמולציית מובייל
  שדה אופציונלי
  אם מוגדר ל-true, Lighthouse ישתמש באמולציית מכשיר מובייל ומסך כדי לבדוק את העמוד בסביבת מובייל
  אם מוגדר ל-false, התוצאות יסופקו עבור שולחן עבודה
  ערך ברירת מחדל: false
- language_code
  סוג: string | null
  
  קוד שפה של Lighthouse
  שדה אופציונלי
  אפשר לקבל את רשימת השפות הזמינות של מנוע החיפוש עם language_code שלהן באמצעות בקשה נפרדת ל-https://api.dataforseo.com/v3/on_page/lighthouse/languages
  ערך ברירת מחדל:
  en
- language_name
  סוג: string | null
  
  שם שפה של Lighthouse
  שדה אופציונלי
  אפשר לקבל את רשימת השפות הזמינות של מנוע החיפוש עם language_name שלהן באמצעות בקשה נפרדת ל-https://api.dataforseo.com/v3/on_page/lighthouse/languages
  ערך ברירת מחדל:
  English
- pingback_url
  סוג: string | null
  
  כתובת URL לקבלת התראות על השלמת משימה
  שדה אופציונלי
  כשהמשימה מושלמת נודיע לך באמצעות בקשת GET לכתובת ה-URL שציינת
  אפשר להשתמש במחרוזת ‘$id’ כמשתנה $id ובמחרוזת ‘$tag’ כמשתנה $tag מקודד ב-URL. נגדיר את הערכים הדרושים לפני שליחת הבקשה.
  דוגמה:
  http://your-server.com/pingscript?id=$id
  http://your-server.com/pingscript?id=$id&tag=$tag
  הערה: תווים מיוחדים ב-pingback_url יקודדו ב-URL;
  לדוגמה, התו # יקודד ל-%23 מידע נוסף במרכז העזרה שלנו
- tag
  סוג: string | null
  
  מזהה משימה מוגדר על ידי המשתמש
  שדה אופציונלי
  מגבלת התווים היא 255
  אפשר להשתמש בפרמטר הזה כדי לזהות את המשימה ולהתאים אותה לתוצאה
  את ערך ה-tag שציינתם תמצאו באובייקט data של התגובה
- url
  סוג: string
  
  כתובת URL של יעד
  שדה חובה
  יש לציין את עמוד היעד בכתובת URL מוחלטת (כולל http:// או https://)
  דוגמה:
  https://dataforseo.com/
- version
  סוג: string | null
  
  גרסת Lighthouse
  שדה אופציונלי
  אפשר לקבל את התוצאות הספציפיות לגרסה מסוימת של Lighthouse על ידי ציון המספר שלה
  רשימת הגרסאות הזמינות זמינה דרך נקודת הקצה Lighthouse Versions

תגובות

200
סוג: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo
cost
סוג: number | null פורמט: double

סך עלות המשימות, בדולר ארה״ב

status_code
סוג: integer | null

קוד סטטוס כללי את הרשימה המלאה של קודי התגובה אפשר למצוא כאן

status_message
סוג: string | null

הודעה אינפורמטיבית כללית את הרשימה המלאה של ההודעות האינפורמטיביות הכלליות אפשר למצוא כאן

tasks
סוג: array (object | null)[] | null

מערך משימות

סוג: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
cost
סוג: number | null פורמט: double

סך עלות המשימות, בדולר ארה״ב

data
סוג: object | null

מכיל את אותם הפרמטרים שציינתם בבקשת POST

propertyName
סוג: object | null
id
סוג: string | null

מזהה משימה מזהה משימה ייחודי במערכת שלנו בפורמט UUID

path
סוג: array (string | null)[] | null

נתיב URL

result
סוג: array (object | null)[] | null
propertyName
סוג: object | null
result_count
סוג: integer | null פורמט: int64

מספר הפריטים במערך result

status_code
סוג: integer | null

קוד הסטטוס של המשימה נוצר על ידי DataForSEO ויכול להיות בטווח הבא: 10000-60000 את הרשימה המלאה של קודי התגובה אפשר למצוא כאן

status_message
סוג: string | null

הודעה אינפורמטיבית של המשימה את הרשימה המלאה של ההודעות האינפורמטיביות הכלליות אפשר למצוא כאן

time
סוג: string | null

זמן ביצוע, בשניות

tasks_count
סוג: integer | null פורמט: int64

מספר המשימות במערך tasks

tasks_error
סוג: integer | null פורמט: int64

מספר המשימות במערך tasks שהוחזרו עם שגיאה

time
סוג: string | null

זמן ביצוע כולל, בשניות

version
סוג: string | null

הגרסה הנוכחית של ה-API
application/json
400

לא ניתן היה לעבד את הבקשה. בדקו את פרמטרי הבקשה.
401

נדרש מפתח API תקף של Felo.
402

לא ניתן להמשיך את הבקשה משום שדרישת חיוב אינה מתקיימת.
403

החשבון אינו מורשה לבצע את הפעולה הזו.
429

הגעתם למגבלת בקשות או לתקרת הוצאה.
502

השירות לא הצליח להשלים את הבקשה.
503

שירות ה-API או החיוב אינו זמין באופן זמני.
504

השירות פג בזמן הטיפול בבקשה.
default

תגובת שגיאה; תגובות מעבר מהמעלה הזרם עשויות להשתמש בפורמטים של הספק

application/json

post/v1/beta/dataforseo/on_page/lighthouse/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

הצגת סכמה

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        null
      ]
    }
  ]
}

פעולה מוצלחת

הגדרת משימות Lighthouse

אימותRequired

DataForSEO

הגדרת משימות Lighthouse

מראה תמחור