v0.2.0-beta

OpenAPI 3.1.0

Souhrn OnPage API

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

get/v1/beta/dataforseo/on_page/summary/{id}

Souhrn OnPage API

Stav a hlavní metriky jednoho procházení podle id. Vrací crawl_progress, crawl_status, crawl_gateway_address, crawl_stop_reason, domain_info a page_metrics. 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. Tímto také poznáte, že procházení skončilo — dotazujte se, dokud crawl_progress nebude finished, než přečtete jakýkoli jiný endpoint zde; jinak přečtete částečné výsledky, které vypadají jako skutečné. 💰 Zdarma na straně upstreamu: dotaz na dokončené procházení nic nestojí, platí se jen samotné procházení.

Cenová reference

Účtování: nahlášené náklady na odpověď.
Referenční odhad požadavku: USD 0.012.
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.

Parametry cesty

id
Typ: string
povinné

identifikátor úlohy
povinné pole
toto ID můžete získat v odpovědi endpointu Task POST
příklad:
“07131248-1535-0216-1000-17384017ad04”

Odpovědi

200
Typ: object | null · Response36Afe1097B20_OnPageSummaryResponseInfo
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_OnPageSummaryTaskInfo
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

pole výsledků

crawl_gateway_address
Typ: string | null

IP adresa crawleru
zobrazuje IP adresu, kterou crawler použil k zahájení aktuální relace procházení
úplný seznam IP adres používaných naším crawlerem najdete v části Přehled

crawl_progress
Typ: string | null

stav relace procházení
možné hodnoty: in_progress, finished

crawl_status
Typ: object | null · Response36Afe1097B20_CrawlStatusInfo

podrobnosti relace procházení

max_crawl_pages
Typ: integer | null Formát: int64

maximální počet stránek k procházení udává limit max_crawl_pages, který jste zadali při nastavování úlohy

pages_crawled
Typ: integer | null Formát: int64

počet procházených stránek

pages_in_queue
Typ: integer | null Formát: int64

počet stránek, které jsou aktuálně ve frontě procházení

crawl_stop_reason
Typ: string | null

důvod zastavení procházení
informace o důvodu zastavení procesu procházení;
možné hodnoty:
limit_exceeded – byl překročen limit nastavený v max_crawl_pages;
empty_queue – všechny URL ve frontě byly projity;
force_stopped – proces procházení byl zastaven pomocí funkce On Page API Force Stop;
unexpected_exception – při procházení target došlo k interní chybě; další informace získáte u podpory

domain_info
Typ: object | null · Response36Afe1097B20_DomainInfo

informace pro celou doménu
on-page informace o cílové doméně a procesu procházení

canonicalization_status_code
Typ: integer | null

kód stavu vrácený kanonizovanou stránkou
kontrola chování serveru, když se náš crawler pokouší přistoupit k webu přes IP;
ve většině případů se doporučuje, aby kanonizované stránky odpovídaly kódem stavu 301 nebo 302

checks
Typ: object | null

kontroly webu
další kontroly on-page související s webem

propertyName
Typ: boolean | null
cms
Typ: string | null

systém pro správu obsahu
systém pro správu obsahu zjištěný na webu
obsah meta tagu generator
data se přebírají z první náhodné stránky, která vrací kód odpovědi 200
pokud náš crawler nedokázal cms identifikovat, hodnota bude null

crawl_end
Typ: string | null

čas ukončení procházení
datum a čas ukončení procházení
ve formátu UTC: „yyyy-mm-dd hh-mm-ss +00:00”
příklad:
2019-11-15 12:57:46 +00:00
Poznámka: informativní pouze tehdy, když je "crawl_progress" nastaveno na "finished"
pokud je "crawl_progress" nastaveno na in_progress, hodnota bude null

crawl_start
Typ: string | null

čas zahájení procházení
datum a čas, kdy byl web odeslán k procházení
ve formátu UTC: „yyyy-mm-dd hh-mm-ss +00:00”
příklad:
2019-11-15 12:57:46 +00:00

directory_browsing_status_code
Typ: integer | null

kód stavu vrácený adresářem
kód stavu vrácený stránkou adresáře na cílovém webu
ve většině případů se doporučuje, aby adresáře odpovídaly kódem stavu 403 nebo 401

extended_crawl_status
Typ: string | null

stav a chyby procházení
udává důvod, proč web nebyl procházen;
může nabývat následujících hodnot:
no_errors — nebyly zjištěny chyby procházení;
site_unreachable — náš crawler se k webu nedostal, a proto nemohl získat kód stavu;
invalid_page_status_code — kód stavu první procházené stránky >= 400;
forbidden_meta_tag — první procházená stránka obsahuje tag <meta robots="noindex">;
forbidden_robots — robots.txt zakazuje procházení stránky;
forbidden_http_header — hlavička HTTP stránky obsahuje "X-Robots-Tag: noindex" ;
too_many_redirects — první procházená stránka má více než 10 přesměrování;
unknown — důvod není znám

ip
Typ: string | null

IP adresa domény

main_domain
Typ: string | null

název kořenové domény

name
Typ: string | null

název domény

page_not_found_status_code
Typ: integer | null

kód stavu vrácený neexistující stránkou
ve většině případů se doporučuje, aby server vracel kód odpovědi 404

server
Typ: string | null

server webu
verze serveru zjištěná na webu
obsah hlavičky server
informace se přebírají z první stránky, jejíž kód odpovědi je 200

ssl_info
Typ: object | null · Response36Afe1097B20_SslInfo

informace o certifikátu SSL
informace o protokolu Secure Sockets Layer zjištěném na webu

certificate_expiration_date
Typ: string | null

datum vypršení platnosti certifikátu SSL
datum a čas, kdy certifikát SSL vyprší
ve formátu UTC: „yyyy-mm-dd hh-mm-ss +00:00”
příklad:
2019-11-15 12:57:46 +00:00

certificate_hash
Typ: string | null

hash certifikátu SSL
verze hashovací funkce certifikátu SSL

certificate_issuer
Typ: string | null

certifikační autorita SSL
subjekt, který vydal zjištěný certifikát SSL

certificate_subject
Typ: string | null

subjekt certifikátu SSL
subjekt přidružený k veřejnému klíči

certificate_version
Typ: integer | null

verze certifikátu SSL
označuje verzi X.509 použitou certifikátem SSL

valid_certificate
Typ: boolean | null

platnost certifikátu SSL
označuje, zda zjištěný certifikát SSL na webu není vypršelý, pozastavený, odvolaný nebo neplatný

total_pages
Typ: integer | null Formát: int64

celkový počet procházených stránek
celkový počet stránek, které byly procházeny

total_uncrawlable_resources
Typ: integer | null Formát: int64

celkový počet neprocházetelných zdrojů
celkový počet zdrojů, které nebylo možné procházet;
zdroj se považuje za neprocházetelný, když skutečný typ obsahu zdroje neodpovídá typu obsahu očekávanému crawlerem

www_redirect_status_code
Typ: integer | null

kód stavu přesměrování
kód stavu přesměrování z www na bez www
ve většině případů se doporučuje, aby přesměrování vracelo kód stavu 301

page_metrics
Typ: object | null · Response36Afe1097B20_PageMetrics

informace specifické pro stránku
informace o metrikách stránek cílového webu

broken_links
Typ: integer | null

počet nefunkčních odkazů
počet nefunkčních odkazů na všech procházených stránkách cílového webu

broken_resources
Typ: integer | null

počet nefunkčních zdrojů
počet obrázků a dalších zdrojů s nefunkčními odkazy

checks
Typ: object | null

on-page kontroly specifické pro stránku

propertyName
Typ: integer | null Formát: int64

Signed 64-bit integers (long type).

duplicate_content
Typ: integer | null

počet stránek s duplicitním obsahem

duplicate_description
Typ: integer | null

počet stránek s duplicitními popisy

duplicate_title
Typ: integer | null

počet stránek s duplicitními titulky

links_external
Typ: integer | null

počet externích odkazů
počet odkazů směřujících na jiné weby

links_internal
Typ: integer | null

počet interních odkazů
počet odkazů směřujících na jiné stránky v rámci cílového webu

links_relation_conflict
Typ: integer | null

počet odkazů na cílovém webu, které mohou být v konfliktu
například pokud je "links_relation_conflict": 2, cílový web odkazuje na stejný zdroj alespoň jedním interním odkazem s atributem rel="nofollow" a alespoň jedním odkazem dofollow

non_indexable
Typ: integer | null

počet neindexovatelných stránek
počet stránek, kterým je indexování zablokováno Googlem a dalšími vyhledávači pomocí robots.txt, hlaviček HTTP nebo nastavení meta tagů;
seznam neindexovatelných URL můžete získat pomocí tohoto endpointu

onpage_score
Typ: number | null

ukazuje, jak je web optimalizovaný na stupnici 100 bodů
toto pole ukazuje, jak je web optimalizovaný s ohledem na zjištěné kritické problémy a varování na stránce;
100 je nejvyšší možné skóre, které znamená, že web nemá žádné kritické problémy ani důležitá varování;
poznámka: tato hodnota závisí na počtu procházených stránek;
více o výpočtu této metriky najdete v tomto článku centra nápovědy

redirect_loop
Typ: integer | null

počet řetězců přesměrování, které začínají a končí na stejné URL
počet řetězců přesměrování, kde cílová URL přesměrovává zpět na původní URL

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

get/v1/beta/dataforseo/on_page/summary/{id}

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/summary/00000000-0000-0000-0000-000000000000 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

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": [
        {
          "crawl_progress": null,
          "crawl_status": {
            "max_crawl_pages": null,
            "pages_in_queue": null,
            "pages_crawled": null
          },
          "crawl_gateway_address": null,
          "crawl_stop_reason": null,
          "domain_info": {
            "name": null,
            "cms": null,
            "ip": null,
            "server": null,
            "crawl_start": null,
            "crawl_end": null,
            "extended_crawl_status": null,
            "ssl_info": "[Max Depth Exceeded]",
            "checks": null,
            "total_pages": null,
            "total_uncrawlable_resources": null,
            "page_not_found_status_code": null,
            "canonicalization_status_code": null,
            "directory_browsing_status_code": null,
            "www_redirect_status_code": null,
            "main_domain": null
          },
          "page_metrics": {
            "links_external": null,
            "links_internal": null,
            "duplicate_title": null,
            "duplicate_description": null,
            "duplicate_content": null,
            "broken_links": null,
            "broken_resources": null,
            "links_relation_conflict": null,
            "redirect_loop": null,
            "onpage_score": null,
            "non_indexable": null,
            "checks": null
          }
        }
      ]
    }
  ]
}

Úspěšná operace

Souhrn OnPage API

OvěřováníRequired

DataForSEO

Souhrn OnPage API

Cenová reference