v0.2.0-beta

OpenAPI 3.1.0

Vytváření úloh OnPage

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/task_post

Vytváření úloh OnPage

Spustí procházení target a vrátí id úlohy v tasks[0].id — toto id je klíč, který potřebuje každý další nástroj v této rodině, proto si jej ponechte. max_crawl_pages omezuje procházení, start_url, max_crawl_depth, priority_urls a crawl_delay jej formují a store_raw_html rozhoduje, zda bude mít post_dataforseo_on_page_raw_html později co vrátit. 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. ⚠️ Nejde o obvyklou dvojici submit/fetch: procházení je relace, kterou pak podle id dotazuje tucet dalších nástrojů. Dotazujte se na get_dataforseo_on_page_summary, dokud crawl_progress nebude finished; procházení jedné stránky example.com trvalo výrazně méně než minutu.

Cenová reference

Účtování: nahlášené náklady na odpověď.
Referenční odhad požadavku: USD 0.003.
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)[]
- accept_language
 Typ: string | null
 
 jazyková hlavička pro přístup k webu
 volitelné pole
 podporovány jsou všechny formáty lokalizace (xx, xx-XX, xxx-XX atd.)
 Poznámka: pokud tento parametr nezadáte, některé weby mohou přístup odmítnout; v takovém případě budou stránky vráceny s hodnotou "type":"broken v poli odpovědi
- allow_subdomains
 Typ: boolean | null
 
 zahrnout stránky na subdoménách
 volitelné pole
 nastavte na true, pokud chcete procházet všechny subdomény cílového webu
 výchozí hodnota: false
- allowed_subdomains
 Typ: array string[] | null
 
 subdomény k procházení
 volitelné pole
 zadejte subdomény, které chcete procházet
 příklad: ["blog.site.com", "my.site.com", "shop.site.com"]
 Poznámka: pro použití tohoto parametru musí být parametr allow_subdomains nastaven na false;
 v opačném případě bude obsah pole allowed_subdomains ignorován a výsledky budou vráceny pro všechny subdomény
- browser_preset
 Typ: string | null
 
 předvolba parametrů obrazovky prohlížeče
 volitelné pole
 pokud toto pole použijete, nemusíte uvádět browser_screen_width, browser_screen_height, browser_screen_scale_factormožné hodnoty:
 desktop, mobile, tabletdesktop předvolba použije následující hodnoty:browser_screen_width: 1920
 browser_screen_height: 1080
 browser_screen_scale_factor: 1mobile předvolba použije následující hodnoty:browser_screen_width: 390
 browser_screen_height: 844
 browser_screen_scale_factor: 3tablet předvolba použije následující hodnoty:browser_screen_width: 1024
 browser_screen_height: 1366
 browser_screen_scale_factor: 2
 Poznámka: pro použití tohoto parametru nastavte enable_javascript nebo enable_browser_rendering na true
- browser_screen_height
 Typ: integer | null
 
 výška obrazovky prohlížeče
 volitelné pole
 můžete nastavit vlastní výšku obrazovky prohlížeče pro provedení auditu konkrétního zařízení;
 pokud toto pole použijete, nemusíte uvádět browser_preset, protože bude ignorováno;
 Poznámka: pro použití tohoto parametru nastavte enable_javascript nebo enable_browser_rendering na trueminimální hodnota v pixelech: 240
 maximální hodnota v pixelech: 9999
- browser_screen_scale_factor
 Typ: number | null
 
 faktor měřítka obrazovky prohlížeče
 volitelné pole
 můžete nastavit vlastní poměr rozlišení obrazovky prohlížeče pro provedení auditu konkrétního zařízení;
 pokud toto pole použijete, nemusíte uvádět browser_preset, protože bude ignorováno;
 Poznámka: pro použití tohoto parametru nastavte enable_javascript nebo enable_browser_rendering na trueminimální hodnota: 0.5
 maximální hodnota: 3
- browser_screen_width
 Typ: integer | null Formát: int64
 
 šířka obrazovky prohlížeče
 volitelné pole
 můžete nastavit vlastní šířku obrazovky prohlížeče pro provedení auditu konkrétního zařízení;
 pokud toto pole použijete, nemusíte uvádět browser_preset, protože bude ignorováno;
 Poznámka: pro použití tohoto parametru nastavte enable_javascript nebo enable_browser_rendering na trueminimální hodnota v pixelech: 240
 maximální hodnota v pixelech: 9999
- calculate_keyword_density
 Typ: boolean | null
 
 vypočítat hustotu klíčových slov pro cílovou doménu
 volitelné pole
 nastavte na true, pokud chcete vypočítat hustotu klíčových slov pro stránky webu
 výchozí hodnota: false
 Poznámka: pokud tento parametr použijete, budou účtovány dodatečné poplatky; více informací o nákladech úloh s tímto parametrem najdete v našem článku nápovědy
 po dokončení procházení můžete hodnoty hustoty klíčových slov získat pomocí endpointu Keyword Density
- check_spell
 Typ: boolean | null
 
 kontrolovat pravopis
 volitelné pole
 nastavte na true, pokud chcete kontrolovat pravopis na webu pomocí knihovny Hunspell
 výchozí hodnota: false
- check_spell_exceptions
 Typ: array string[] | null
 
 slova vyloučená z kontroly pravopisu
 volitelné pole
 zadejte slova, která chcete vyloučit z kontroly pravopisu
 maximální délka slova: 100 znaků
 maximální počet slov: 1000
 příklad: "SERP", "minifiers", "JavaScript"
- check_spell_language
 Typ: string | null
 
 jazyk kontroly pravopisu
 volitelné pole
 podporované jazyky: 'hy', 'eu', 'bg', 'ca', 'hr', 'cs', 'da', 'nl', 'en', 'eo', 'et', 'fo', 'fa', 'fr', 'fy', 'gl', 'ka', 'de', 'el', 'he', 'hu', 'is', 'ia', 'ga', 'it', 'rw', 'la', 'lv', 'lt', 'mk', 'mn', 'ne', 'nb', 'nn', 'pl', 'pt', 'ro', 'gd', 'sr', 'sk', 'sl', 'es', 'sv', 'tr', 'tk', 'uk', 'vi'
 Poznámka: pokud není jazyk zadán, bude nastaven automaticky na základě obsahu stránky
- checks_threshold
 Typ: object | null
 
 vlastní prahové hodnoty pro kontroly
 volitelné pole
 můžete zadat vlastní prahové hodnoty pro parametry zahrnuté v objektu checks odpovědí OnPage API;
 Poznámka: upravovat lze pouze celočíselné prahové hodnoty;
 například parametry high_loading_time a large_page_size jsou ve výchozím nastavení nastaveny na 3 sekundy a 1 megabajt;
 pokud chcete tyto prahové hodnoty změnit na 1 sekundu a 1000 kB, použijte následující úryvek:
 "checks_threshold": { "high_loading_time": 1, "large_page_size": 1000 }
 dostupné přizpůsobitelné parametry s výchozími hodnotami:
 "title_too_short", default value: 30, type: "int" "title_too_long", default value: 65, type: "int" "small_page_size", default value: 1024, type: "int" "large_page_size", default value: 1048576 (1024 * 1024), type: "int" "low_character_count", default value: 1024, type: "int" "high_character_count", default value: 256000 (250 * 1024), type: "int" "low_content_rate", default value: 0.1, type: "float" "high_content_rate", default value: 0.9, type: "float" "high_loading_time", default value: 3000, type: "int" "high_waiting_time", default value: 1500, type: "int" "low_readability_rate", default value: 15.0, type: "float" "irrelevant_description", default value: 0.2, type: "float" "irrelevant_title", default value: 0.3, type: "float" "irrelevant_meta_keywords", default value: 0.6, type: "float"
 
 propertyName
 Typ: integer | null Formát: int64
 
 Signed 64-bit integers (long type).
- crawl_delay
 Typ: integer | null
 
 prodleva mezi požadavky, ms
 volitelné pole
 vlastní prodleva mezi požadavky crawleru na server
 výchozí hodnota: 2000
- crawl_sitemap_only
 Typ: boolean | null
 
 procházet pouze stránky uvedené v sitemapě
 volitelné pole
 nastavte na true, pokud chcete procházet pouze stránky uvedené v sitemapě
 pokud tento parametr nastavíte na true a nezadáte custom_sitemap, budeme procházet výchozí sitemapu
 výchozí hodnota: false
 Poznámka: pokud chcete tento parametr použít, musí mít respect_sitemap hodnotu true
- custom_js
 Typ: string | null
 
 vlastní javascript
 volitelné pole
 Poznámka: doba provádění skriptu, který zde zadáte, by měla být maximálně 700 ms. Můžete například použít následující úryvek JS ke zjištění, zda web obsahuje Google Tag Manager jako atribut scr:
 let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i < document.scripts.length; i++) {rn let src = document.scripts[i].getAttribute("src");rn if (src != undefined) {rn if (src.indexOf("analytics.js") >= 0)rn meta.haveGoogleAnalytics = true;rntif (src.indexOf("gtm.js") >= 0)rn meta.haveTagManager = true;rn }rn}rnmeta;vracená hodnota závisí na tom, co v tomto poli zadáte. Pokud například zadáte následující skript:
 meta = {}; meta.url = document.URL; meta.test = 'test'; meta;
 jako odpověď obdržíte následující data:
 "custom_js_response": { "url": "https://dataforseo.com/", "test": "test" }
 Poznámka: délka zadaného skriptu nesmí být delší než 2000 znaků
- custom_robots_txt
 Typ: string | null
 
 vlastní nastavení robots.txt
 volitelné pole
 příklad: Disallow: /directory1/
- custom_sitemap
 Typ: string | null
 
 vlastní URL sitemapy
 volitelné pole
 URL stránky, na které se nachází alternativní sitemapa
 Poznámka: pokud chcete tento parametr použít, musí mít respect_sitemap hodnotu true
- custom_user_agent
 Typ: string | null
 
 vlastní user agent
 volitelné pole
 vlastní user agent pro procházení webu
 příklad: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36
 výchozí hodnota: Mozilla/5.0 (compatible; RSiteAuditor)
- disable_cookie_popup
 Typ: boolean | null
 
 zakázat vyskakovací okno se soubory cookie
 volitelné pole
 nastavte na true, pokud chcete zakázat vyskakovací okno žádající uživatele o souhlas se soubory cookie;
 výchozí hodnota:
 false
- disable_page_checks
 Typ: array string[] | null
 
 zabránit spuštění určitých kontrol stránky
 volitelné pole
 zadejte určité checks, abyste zabránili jejich spuštění a ovlivnění onpage_score; příklad:
 "disable_page_checks": ["is_5xx_code", "is_4xx_code"]
- disable_sitewide_checks
 Typ: array string[] | null
 
 zabránit spuštění určitých kontrol celého webu
 volitelné pole
 zadejte následující checks, abyste zabránili jejich spuštění na webu target:
 "test_page_not_found"
 "test_canonicalization"
 "test_https_redirect"
 "test_directory_browsing"příklad:
 "disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]další informace najdete v našem Centru nápovědy
- disallowed_subdomains
 Typ: array string[] | null
 
 subdomény, které nemají být procházeny
 volitelné pole
 zadejte subdomény, které nechcete procházet
 příklad: ["status.site.com", "docs.site.com"]
 Poznámka: pokud chcete tento parametr použít, musí mít parametr allow_subdomains hodnotu true
- enable_browser_rendering
 Typ: boolean | null
 
 emulovat vykreslování prohlížeče pro měření Core Web Vitals
 volitelné pole
 pomocí tohoto parametru můžete při načítání webové stránky emulovat prohlížeč;
 enable_browser_rendering načítá styly, obrázky, písma, animace, videa a další zdroje na stránce;
 výchozí hodnota: false
 nastavte na true, abyste v odpovědi získali metriky Core Web Vitals (FID, CLS, LCP);
 pokud toto pole použijete, musí být parametry enable_javascript a load_resources nastaveny na true
 Poznámka: pokud tento parametr použijete, budou účtovány dodatečné poplatky; další informace o ceně úloh s tímto parametrem najdete v našem článku nápovědy; náklady lze vypočítat na stránce Ceny
- enable_content_parsing
 Typ: boolean | null
 
 parsovat obsah na procházených stránkách
 volitelné pole
 nastavte na true, pokud chcete použít endpoint OnPage Content Parsing
 výchozí hodnota: false
- enable_javascript
 Typ: boolean | null
 
 načítat javascript na stránce
 volitelné pole
 nastavte na true, pokud chcete načítat skripty dostupné na stránce
 výchozí hodnota: false
 Poznámka: pokud tento parametr použijete, budou účtovány dodatečné poplatky; další informace o ceně úloh s tímto parametrem najdete v našem článku nápovědy; náklady lze vypočítat na stránce Ceny
- enable_www_redirect_check
 Typ: boolean | null
 
 zkontrolovat, zda doména zavedla přesměrování www
 volitelné pole
 nastavte na true, pokud chcete zkontrolovat, zda požadovaná doména zavedla přesměrování z www na bez www nebo z bez www na www;
 výchozí hodnota: false
- enable_xhr
 Typ: boolean | null
 
 povolit XMLHttpRequest na stránce
 volitelné pole
 nastavte na true, pokud chcete, aby náš crawler požadoval data z webového serveru pomocí objektu XMLHttpRequest
 výchozí hodnota: false; pokud toto pole použijete, musí být enable_javascript nastaveno na true;
- force_sitewide_checks
 Typ: boolean | null
 
 povolit kontroly celého webu při procházení jedné stránky
 volitelné pole
 nastavte na true, abyste při procházení jedné stránky získali data z kontrol celého webu;
 výchozí hodnota: false
- load_resources
 Typ: boolean | null
 
 načítat zdroje
 volitelné pole
 nastavte na true, pokud chcete načítat obrázky, šablony stylů, skripty a nefunkční zdroje
 výchozí hodnota: false
 Poznámka: pokud tento parametr použijete, budou účtovány dodatečné poplatky; další informace o ceně úloh s tímto parametrem najdete v našem článku nápovědy; náklady lze vypočítat na stránce Ceny
- max_crawl_depth
 Typ: integer | null
 
 hloubka procházení
 volitelné pole
 hloubka propojení procházených stránek;
 například výchozí stránka procházení je úroveň 0, stránky, na které z ní vedou odkazy, jsou úroveň 1 atd.
- max_crawl_pages
 Typ: integer
 
 limit procházených stránek
 povinné pole
 počet stránek k procházení v zadané doméně
 Poznámka:
 pokud nastavíte max_crawl_pages na 1 a nezadáte start_url nebo v něm uvedete domovskou stránku, budou následující kontroly celého webu zakázány:
 test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect
 chcete-li je přesto povolit, nastavte force_sitewide_checks na true. Pokud nastavíte max_crawl_pages na 1 a zadáte start_url jinou než domovskou stránku, budou všechny kontroly celého webu zakázány;
 chcete-li je přesto povolit, nastavte force_sitewide_checks na true
- pingback_url
 Typ: string | null
 
 URL oznámení o dokončené úloze
 volitelné pole
 po dokončení úlohy vás upozorníme požadavkem GET odeslaným na zadanou URL
 řetězec ‘$id’ můžete použít jako proměnnou $id a ‘$tag’ jako proměnnou $tag kódovanou v URL. Před odesláním požadavku nastavíme potřebné hodnoty.
 příklad:
 http://your-server.com/pingscript?id=$id
 http://your-server.com/pingscript?id=$id&tag=$tag
 Poznámka: speciální znaky v pingback_url budou kódovány v URL;
 mj. znak # bude zakódován jako %23
 
 další informace najdete v Centru nápovědy
- priority_urls
 Typ: array string[] | null
 
 adresy URL procházené mimo frontu
 volitelné pole
 adresy URL uvedené v tomto poli budou procházeny přednostně, mimo frontu procházení;
 Poznámka: musíte zadat absolutní URL;
 můžete zadat až 20 adres URL;
 všechny adresy URL v poli musí patřit doméně target;
 subdomény budou ignorovány, pokud parametr allow_subdomains nemá hodnotu true; příklad:
 "priority_urls": [ "https://dataforseo.com/apis/serp-api", "https://dataforseo.com/contact" ]
- respect_sitemap
 Typ: boolean | null
 
 respektovat sitemapu při procházení
 volitelné pole
 nastavte na true, pokud chcete při procházení dodržet pořadí stránek uvedené v primární sitemapě;
 výchozí hodnota: false
 Poznámka: pokud nastavíte true, bude hodnota click_depth v odpovědi API rovna 0;
 pole max_crawl_depth v požadavku bude ignorováno; počet stránek k procházení můžete určit parametrem max_crawl_pages
- return_despite_timeout
 Typ: boolean | null
 
 vracet data stránek i přes chybu časového limitu
 volitelné pole
 pokud je true, data budou vrácena pro stránky, které se nestihly načíst do 120 sekund a odpověděly chybou časového limitu;
 výchozí hodnota: false
- robots_txt_merge_mode
 Typ: string | null
 
 sloučit s nastavením robots.txt nebo je přepsat
 volitelné pole
 možné hodnoty: merge, override;
 nastavte na override, pokud chcete ignorovat omezení procházení webu a další nastavení robots.txt
 výchozí hodnota: merge;
 Poznámka: pokud nastavíte override, zadejte parametr custom_robots_txt
- start_url
 Typ: string | null
 
 první URL k procházení
 volitelné pole
 Poznámka: musíte zadat absolutní URL
 pokud chcete procházet jednu stránku, zadejte její URL do tohoto pole a navíc nastavte parametr max_crawl_pages na 1
 můžete také použít endpoint live Instant Pages k získání dat specifických pro stránku
- store_raw_html
 Typ: boolean | null
 
 ukládat HTML procházených stránek
 volitelné pole
 nastavte na true, pokud chcete získat HTML stránky pomocí endpointu OnPage Raw HTML
 výchozí hodnota: false
- support_cookies
 Typ: boolean | null
 
 podporovat soubory cookie na procházených stránkách
 volitelné pole
 nastavte na true, abyste při procházení stránek podporovali soubory cookie
 výchozí hodnota: false
- switch_pool
 Typ: boolean | null
 
 přepnout pool proxy
 volitelné pole
 pokud je true, k získání požadovaných dat budou použity další pooly proxy;
 parametr lze použít, pokud je současně nastaveno mnoho úloh, což vede k občasným chybám rate-limit a/nebo site_unreachable
- 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
- target
 Typ: string
 
 cílová doména
 povinné pole
 název domény je nutné zadat bez https:// a www.
 pokud zadáte URL stránky, výsledky budou vráceny pro doménu obsaženou v URL
- validate_micromarkup
 Typ: boolean | null
 
 povolit validaci mikrodata
 volitelné pole
 nastavte na true, pokud chcete použít endpoint OnPage API Microdata
 výchozí hodnota: false

Odpovědi

200
Typ: object | null · Response36Afe1097B20_OnPageTaskPostResponseInfo
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_OnPageTaskPostTaskInfo
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: object | null

pole výsledků
v tomto případě bude hodnota 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/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "max_crawl_pages": 10,
    "load_resources": true,
    "enable_javascript": true,
    "custom_js": "meta = {}; meta.url = document.URL; meta;",
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

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

Vytváření úloh OnPage

OvěřováníRequired

DataForSEO

Vytváření úloh OnPage

Cenová reference