v0.2.0-beta

OpenAPI 3.1.0

Živý OnPage Lighthouse JSON

Felo API Support

MIT

Server

https://openapi.felo.ai

Klientské knihovny

Shell Curl

DataForSEO

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

DataForSEO Operace

post/v1/beta/dataforseo/on_page/lighthouse/live/json

Živý OnPage Lighthouse JSON

Spustí audit Google Lighthouse pro jednu url a vrátí plnou zprávu: lighthouseVersion, requestedUrl, finalUrl, fetchTime, gatherMode, runWarnings a skóre každého auditu a kategorie. for_mobile přepíná emulované zařízení, categories a audits běh zužují. Předáním categories nebo audits jej zmenšíte; když jde jen o to, proč je stránka pomalá, dejte přednost post_dataforseo_on_page_waterfall. Zabaleno do obálky DataForSEO: data v tasks[0].result, výsledek v tasks[0].status_code — odmítnutý požadavek stále vrací HTTP 200.

Cenová reference

Účtování: nahlášené náklady na odpověď.
Referenční odhad požadavku: USD 0.005.
Referenční multiplikátor zákazníka: 1.0. Znovu jej neaplikujte na již zúčtovanou částku zákazníka.

Pouze referenční metadata, nikoli nabídka pro účet, garantovaná cena či limit utrácení. Kredity prostředků nejsou kredity Felo. Konečné účtování se řídí fakturačními záznamy Felo.

Tělo

application/json

Typ: array (object | null)[]
- audits
  Typ: array string[] | null
  
  audity Lighthouse
  volitelné pole
  audity jsou jednotlivé testy, které Lighthouse provádí pro každou konkrétní funkci/optimalizaci/metriku, aby vytvořil číselné skóre (viz oficiální definice);
  
  pokud toto pole ignorujete, vrátíme data pro všechny audity;
  toto pole použijte k získání dat pro konkrétní audity, které zde uvedete;
  
  Poznámka: některé audity nepatří do konkrétní kategorie a jsou samostatnými měřeními kvality stránky;
  
  obecně může nastat několik případů použití:
  
  1. pokud ignorujete categories, můžete toto pole použít k získání dat pouze pro zadané audity
  například pokud ignorujete "categories" a zadáte "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], získáte data pouze pro tyto audity
  
  2. pokud zadáte kategorii, můžete toto pole použít k dodatečnému získání auditů, které nepatří do zadaných kategorií
  například pokud zadáte "categories": ["seo"] a "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"], získáte pouze tyto audity v kategorii "performance" a všechny audity v kategorii "seo"
  
  úplný seznam možných auditů najdete zde
- browser_cpu_throttling_multiplier
  Typ: number | null
  
  násobitel omezení CPU prohlížeče
  vyžadováno, pokud je browser_network_throttling_method nastaveno na devtools;
  nastavte násobitel omezení CPU pro simulaci výkonnostních podmínek zařízení během auditu Lighthouse;
  lze zadat v rozsahu: 1–4;
  Poznámka: tento parametr se použije pouze tehdy, když je browser_network_throttling_method nastaveno na devtools;
- browser_network_throttling
  Typ: string | null
  
  omezení sítě prohlížeče
  vyžadováno, pokud je browser_network_throttling_method nastaveno na devtools;
  nastavte profil omezení sítě pro simulaci podmínek rychlosti připojení během auditu Lighthouse;
  možné hodnoty: no_throttling, fast_4g, slow_4g, regular_3g, pc;
  Poznámka: tento parametr se použije pouze tehdy, když je browser_network_throttling_method nastaveno na devtools;
- browser_network_throttling_method
  Typ: string | null
  
  metoda omezení sítě prohlížeče
  volitelné pole
  definuje metodu použitého omezení během auditu Lighthouse;
  možné hodnoty:
  simulate - vypočítá odhadované výkonnostní metriky bez uplatnění explicitního omezení;
  devtools - použije nastavení omezení uvedená v browser_network_throttling a browser_cpu_throttling_multiplier;
  provided - použije síťové podmínky prostředí procházení;
- browser_screen_height
  Typ: integer | null
  
  výška obrazovky prohlížeče
  volitelné pole
  nastavte výšku obrazovky prohlížeče použitého pro audit Lighthouse pro emulaci konkrétního zařízení;
  lze zadat v rozsahu: 240–9999;
- browser_screen_scale_factor
  Typ: number | null
  
  faktor měřítka obrazovky prohlížeče
  volitelné pole
  nastavte poměr pixelů zařízení prohlížeče použitého pro audit Lighthouse;
  lze zadat v rozsahu: 0.5–3;
- browser_screen_width
  Typ: integer | null Formát: int64
  
  šířka obrazovky prohlížeče
  volitelné pole
  nastavte šířku obrazovky prohlížeče použitého pro audit Lighthouse pro emulaci konkrétního zařízení;
  lze zadat v rozsahu: 240–9999;
- categories
  Typ: array string[] | null
  
  kategorie auditů Lighthouse
  volitelné pole
  každá kategorie je soubor auditů a skupin auditů, na který se vztahuje vážení a bodování dané části (viz oficiální definice)
  
  pokud toto pole ignorujete, vrátíme data pro všechny kategorie, pokud nezadáte audits
  toto pole použijte k získání dat pro konkrétní kategorie, které zde uvedete
  
  možné hodnoty:
  seo, performance, best_practices, accessibility
- custom_user_agent
  Typ: string | null
  
  vlastní user agent
  volitelné pole
  zadejte vlastní user agent, který prohlížeč používá při auditu Lighthouse;
  lze zadat až do 254 znaků;
- for_mobile
  Typ: boolean | null
  
  použije mobilní emulaci
  volitelné pole
  pokud je nastaveno na true, Lighthouse použije emulaci mobilního zařízení a obrazovky k testování stránky v mobilním prostředí
  pokud je nastaveno na false, výsledky budou poskytnuty pro počítač
  výchozí hodnota: false
- language_code
  Typ: string | null
  
  kód jazyka Lighthouse
  volitelné pole
  seznam dostupných jazyků vyhledávače s jejich language_code můžete získat samostatným požadavkem na https://api.dataforseo.com/v3/on_page/lighthouse/languages
  výchozí hodnota:
  en
- language_name
  Typ: string | null
  
  název jazyka Lighthouse
  volitelné pole
  seznam dostupných jazyků vyhledávače s jejich language_name můžete získat samostatným požadavkem na https://api.dataforseo.com/v3/on_page/lighthouse/languages
  výchozí hodnota:
  English
- tag
  Typ: string | null
  
  uživatelem definovaný identifikátor úlohy
  volitelné pole
  limit znaků je 255
  tento parametr můžete použít k identifikaci úlohy a jejímu spárování s výsledkem
  zadanou hodnotu tag najdete v objektu data odpovědi
- url
  Typ: string
  
  cílová URL
  povinné pole
  cílová stránka musí být zadána jako absolutní URL (včetně http:// nebo https://)
  příklad:
  https://dataforseo.com/
- version
  Typ: string | null
  
  verze Lighthouse
  volitelné pole
  výsledky pro konkrétní verzi Lighthouse můžete získat zadáním jejího čísla
  seznam dostupných verzí je k dispozici v endpointu Lighthouse Versions

Odpovědi

200
Typ: object | null · Response36Afe1097B20_OnPageLighthouseLiveJsonResponseInfo
cost
Typ: number | null Formát: double

celkové náklady na úlohy, USD

status_code
Typ: integer | null

obecný kód stavu úplný seznam kódů odpovědí najdete zde

status_message
Typ: string | null

obecná informační zpráva úplný seznam obecných informačních zpráv najdete zde

tasks
Typ: array (object | null)[] | null

pole úloh

Typ: object | null · Response36Afe1097B20_OnPageLighthouseLiveJsonTaskInfo
cost
Typ: number | null Formát: double

celkové náklady na úlohy, USD

data
Typ: object | null

obsahuje stejné parametry, které jste zadali v požadavku POST

propertyName
Typ: object | null
id
Typ: string | null

identifikátor úlohy jedinečný identifikátor úlohy v našem systému ve formátu UUID

path
Typ: array (string | null)[] | null

cesta URL

result
Typ: array (object | null)[] | null

výsledky auditu Lighthouse
toto pole bude obsahovat data podle parametrů zadaných při nastavování úlohy;

všechna pole a jejich popisy jsou k dispozici v oficiální dokumentaci na tomto odkazu.

propertyName
Typ: object | null
result_count
Typ: integer | null Formát: int64

počet prvků v poli result

status_code
Typ: integer | null

stavový kód úlohy vygenerovaný DataForSEO; může být v následujícím rozsahu: 10000-60000 úplný seznam kódů odpovědí najdete zde

status_message
Typ: string | null

informační zpráva úlohy úplný seznam obecných informačních zpráv najdete zde

time
Typ: string | null

doba provedení, sekundy

tasks_count
Typ: integer | null Formát: int64

počet úloh v poli tasks

tasks_error
Typ: integer | null Formát: int64

počet úloh v poli tasks vrácených s chybou

time
Typ: string | null

celková doba provádění, sekundy

version
Typ: string | null

aktuální verze API
application/json
400

Požadavek se nepodařilo zpracovat. Zkontrolujte parametry požadavku.
401

Je vyžadován platný API klíč Felo.
402

V požadavku nelze pokračovat, protože není splněn požadavek na fakturaci.
403

Účet nemá oprávnění tuto operaci provést.
429

Byl dosažen limit požadavků nebo útraty.
502

Služba nemohla požadavek dokončit.
503

API nebo fakturační služba je dočasně nedostupná.
504

Při zpracování požadavku vypršel časový limit služby.
default

Chybová odpověď; odpovědi předávané přímo od upstream poskytovatele mohou používat formáty poskytovatele

application/json

post/v1/beta/dataforseo/on_page/lighthouse/live/json

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/live/json \
  --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"
  }
]'

Zobrazit schéma

{
  "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
      ]
    }
  ]
}

Úspěšná operace

Živý OnPage Lighthouse JSON

OvěřováníRequired

DataForSEO

Živý OnPage Lighthouse JSON

Cenová reference