v0.2.0-beta

OpenAPI 3.1.0

Ringkasan OnPage API

Felo API Support

MIT

Pelayan

https://openapi.felo.ai

Pustaka Klien

Shell Curl

DataForSEO

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

DataForSEO Operasi

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

Ringkasan OnPage API

Keadaan dan metrik utama satu crawl, mengikut id. Memulangkan crawl_progress, crawl_status, crawl_gateway_address, crawl_stop_reason, domain_info dan page_metrics. Dibungkus dalam sampul DataForSEO: data dalam tasks[0].result, hasil dalam tasks[0].status_code - permintaan yang ditolak tetap memulangkan HTTP 200. Ini juga cara untuk mengetahui crawl telah selesai - tinjau sehingga crawl_progress ialah finished sebelum membaca mana-mana endpoint lain di sini, atau anda akan membaca hasil separa yang kelihatan seperti hasil sebenar. 💰 Percuma di pihak upstream: membuat pertanyaan pada crawl yang telah selesai tidak dikenakan kos, hanya crawl itu sendiri.

Rujukan harga

Pemeteran: Kos respons yang dilaporkan.
Anggaran rujukan setiap permintaan: USD 0.012.
Pengganda pelanggan rujukan: 1.0. Jangan gunakan semula pada amaun pelanggan yang telah diselesaikan.

Metadata rujukan sahaja, bukan sebut harga akaun, harga terjamin atau had perbelanjaan. Kredit sumber bukan kredit Felo. Caj akhir mengikut rekod pengebilan Felo.

Parameter Laluan

id
Jenis: string
wajib

pengecam tugas
medan wajib
anda boleh mendapatkan ID ini dalam respons endpoint Task POST
contoh:
“07131248-1535-0216-1000-17384017ad04”

Respons

200
Jenis: object | null · Response36Afe1097B20_OnPageSummaryResponseInfo
cost
Jenis: number | null Format: double

jumlah kos tugas, USD

status_code
Jenis: integer | null

kod status umum; anda boleh menemui senarai penuh kod respons di sini

status_message
Jenis: string | null

mesej maklumat umum; anda boleh menemui senarai penuh mesej maklumat umum di sini

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

tatasusunan tugas

Jenis: object | null · Response36Afe1097B20_OnPageSummaryTaskInfo
cost
Jenis: number | null Format: double

jumlah kos tugas, USD

data
Jenis: object | null

mengandungi parameter yang sama seperti yang anda tentukan dalam permintaan POST

propertyName
Jenis: object | null
id
Jenis: string | null

pengecam tugas; pengecam tugas unik dalam sistem kami dalam format UUID

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

Laluan URL

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

tatasusunan hasil

crawl_gateway_address
Jenis: string | null

alamat IP perangkak
memaparkan alamat IP yang digunakan oleh perangkak untuk memulakan sesi crawl semasa
anda boleh menemui senarai penuh IP yang digunakan oleh perangkak kami dalam bahagian Gambaran Keseluruhan

crawl_progress
Jenis: string | null

status sesi crawl
nilai yang mungkin: in_progress, finished

crawl_status
Jenis: object | null · Response36Afe1097B20_CrawlStatusInfo

butiran sesi crawl

max_crawl_pages
Jenis: integer | null Format: int64

bilangan maksimum halaman untuk dirayau menunjukkan had max_crawl_pages yang anda tetapkan semasa mencipta tugas

pages_crawled
Jenis: integer | null Format: int64

bilangan halaman yang dirayau

pages_in_queue
Jenis: integer | null Format: int64

bilangan halaman yang sedang berada dalam baris gilir perayauan

crawl_stop_reason
Jenis: string | null

sebab crawl berhenti
maklumat tentang sebab proses crawl berhenti;
nilai yang mungkin:
limit_exceeded - had yang ditetapkan dalam max_crawl_pages telah dilampaui;
empty_queue - semua URL dalam baris gilir telah di-crawl;
force_stopped - proses crawl dihentikan menggunakan fungsi On Page API Force Stop;
unexpected_exception - ralat dalaman berlaku semasa crawl target, hubungi sokongan untuk maklumat lanjut

domain_info
Jenis: object | null · Response36Afe1097B20_DomainInfo

maklumat seluruh domain
maklumat on-page tentang domain sasaran dan proses crawl

canonicalization_status_code
Jenis: integer | null

kod status yang dipulangkan oleh halaman terkanonik
pemeriksaan tingkah laku pelayan apabila perangkak kami cuba mengakses laman web melalui IP;
dalam kebanyakan kes, halaman terkanonik disyorkan untuk bertindak balas dengan kod status 301 atau 302

checks
Jenis: object | null

pemeriksaan laman web
pemeriksaan on-page lain yang berkaitan dengan laman web

propertyName
Jenis: boolean | null
cms
Jenis: string | null

sistem pengurusan kandungan
sistem pengurusan kandungan yang dikenal pasti di laman web
kandungan tag meta generator
data diambil daripada halaman rawak pertama yang memulangkan kod respons 200
jika perangkak kami tidak dapat mengenal pasti cms, nilainya ialah null

crawl_end
Jenis: string | null

masa perayauan tamat
tarikh dan masa apabila perayauan selesai
dalam format UTC: “yyyy-mm-dd hh-mm-ss +00:00”
contoh:
2019-11-15 12:57:46 +00:00
Nota: hanya bermaklumat jika "crawl_progress" ialah "finished"
jika "crawl_progress" ialah in_progress, nilainya akan menjadi null

crawl_start
Jenis: string | null

masa perayauan bermula
tarikh dan masa apabila laman web dihantar untuk dirayau
dalam format UTC: “yyyy-mm-dd hh-mm-ss +00:00”
contoh:
2019-11-15 12:57:46 +00:00

directory_browsing_status_code
Jenis: integer | null

kod status yang dipulangkan oleh direktori
kod status yang dipulangkan oleh halaman direktori di laman web sasaran
dalam kebanyakan kes, direktori disyorkan untuk bertindak balas dengan kod status 403 atau 401

extended_crawl_status
Jenis: string | null

status dan ralat perayauan
menunjukkan sebab laman web tidak dirayau;
boleh mengambil nilai berikut:
no_errors - tiada ralat perayauan dikesan;
site_unreachable - perangkak kami tidak dapat mencapai laman web dan oleh itu tidak dapat memperoleh kod status;
invalid_page_status_code - kod status halaman pertama yang dirayau >= 400;
forbidden_meta_tag - halaman pertama yang dirayau mengandungi tag <meta robots="noindex">;
forbidden_robots - robots.txt melarang perayauan halaman;
forbidden_http_header - header HTTP halaman mengandungi "X-Robots-Tag: noindex" ;
too_many_redirects - halaman pertama yang dirayau mempunyai lebih daripada 10 pengalihan;
unknown - sebabnya tidak diketahui

ip
Jenis: string | null

alamat ip domain

main_domain
Jenis: string | null

nama domain akar

name
Jenis: string | null

nama domain

page_not_found_status_code
Jenis: integer | null

kod status yang dipulangkan oleh halaman tidak wujud
dalam kebanyakan kes, pelayan disyorkan untuk memulangkan kod respons 404

server
Jenis: string | null

pelayan laman web
versi pelayan yang dikesan di laman web
kandungan header server
maklumat diambil daripada halaman pertama yang kod responsnya 200

ssl_info
Jenis: object | null · Response36Afe1097B20_SslInfo

info sijil ssl
maklumat tentang protokol Secure Sockets Layer yang dikesan di laman web

certificate_expiration_date
Jenis: string | null

tarikh tamat tempoh sijil ssl
tarikh dan masa apabila sijil ssl tamat tempoh
dalam format UTC: “yyyy-mm-dd hh-mm-ss +00:00”
contoh:
2019-11-15 12:57:46 +00:00

certificate_hash
Jenis: string | null

hash sijil ssl
versi fungsi hash sijil ssl

certificate_issuer
Jenis: string | null

pihak berkuasa sijil ssl
entiti yang mengeluarkan sijil ssl yang dikesan

certificate_subject
Jenis: string | null

subjek sijil ssl
entiti yang berkaitan dengan kunci awam

certificate_version
Jenis: integer | null

versi sijil ssl
menunjukkan versi X.509 yang digunakan oleh sijil ssl

valid_certificate
Jenis: boolean | null

kesahan sijil ssl
menunjukkan sama ada sijil ssl yang dikesan pada laman web adalah sah, iaitu tidak tamat tempoh, digantung, dibatalkan atau tidak sah

total_pages
Jenis: integer | null Format: int64

jumlah halaman yang dirayau
jumlah keseluruhan halaman yang dirayau

total_uncrawlable_resources
Jenis: integer | null Format: int64

jumlah sumber yang tidak dapat dirayau
jumlah keseluruhan sumber yang tidak dapat dirayau;
sumber dianggap tidak dapat dirayau apabila jenis kandungan sebenar sumber tidak sepadan dengan jenis kandungan yang dijangkakan oleh perangkak

www_redirect_status_code
Jenis: integer | null

kod status pengalihan
kod status pengalihan www ke bukan www
dalam kebanyakan kes, pengalihan disyorkan untuk memulangkan kod status 301

page_metrics
Jenis: object | null · Response36Afe1097B20_PageMetrics

maklumat khusus halaman
maklumat metrik tentang halaman laman web sasaran

broken_links
Jenis: integer | null

bilangan pautan rosak
bilangan pautan rosak merentas semua halaman yang di-crawl pada laman web sasaran

broken_resources
Jenis: integer | null

bilangan sumber rosak
bilangan imej dan sumber lain dengan pautan rosak

checks
Jenis: object | null

pemeriksaan on-page khusus halaman

propertyName
Jenis: integer | null Format: int64

Signed 64-bit integers (long type).

duplicate_content
Jenis: integer | null

bilangan halaman dengan kandungan pendua

duplicate_description
Jenis: integer | null

bilangan halaman dengan penerangan pendua

duplicate_title
Jenis: integer | null

bilangan halaman dengan tajuk pendua

links_external
Jenis: integer | null

bilangan pautan luaran
bilangan pautan yang menunjuk ke laman web lain

links_internal
Jenis: integer | null

bilangan pautan dalaman
bilangan pautan yang menunjuk ke halaman lain dalam laman web sasaran

links_relation_conflict
Jenis: integer | null

bilangan pautan pada laman web sasaran yang mungkin bercanggah
sebagai contoh, jika "links_relation_conflict": 2, laman web sasaran merujuk sumber yang sama melalui sekurang-kurangnya satu pautan dalaman dengan atribut rel="nofollow" dan sekurang-kurangnya satu pautan dofollow

non_indexable
Jenis: integer | null

bilangan halaman yang tidak boleh diindeks
bilangan halaman yang disekat daripada diindeks oleh Google dan enjin carian lain melalui robots.txt, pengepala HTTP atau tetapan tag meta;
anda boleh menerima senarai URL yang tidak boleh diindeks menggunakan endpoint ini

onpage_score
Jenis: number | null

menunjukkan tahap pengoptimuman laman web pada skala 100
medan ini menunjukkan tahap pengoptimuman laman web dengan mengambil kira isu on-page kritikal dan amaran yang dikesan;
100 ialah skor tertinggi yang mungkin, bermakna laman web tidak mempunyai isu on-page kritikal dan amaran penting;
ambil perhatian bahawa nilai ini bergantung pada bilangan halaman yang di-crawl;
ketahui lebih lanjut cara metrik dikira dalam artikel pusat bantuan ini

redirect_loop
Jenis: integer | null

bilangan rantaian pengalihan yang bermula dan berakhir pada URL yang sama
bilangan rantaian pengalihan di mana URL destinasi mengalihkan semula ke URL asal

result_count
Jenis: integer | null Format: int64

bilangan elemen dalam array hasil

status_code
Jenis: integer | null

kod status tugas yang dijana oleh DataForSEO; boleh berada dalam julat berikut: 10000-60000; anda boleh menemui senarai penuh kod respons di sini

status_message
Jenis: string | null

mesej maklumat tugas; anda boleh menemui senarai penuh mesej maklumat umum di sini

time
Jenis: string | null

masa pelaksanaan, saat

tasks_count
Jenis: integer | null Format: int64

bilangan tugas dalam array tasks

tasks_error
Jenis: integer | null Format: int64

bilangan tugas dalam array tasks yang dipulangkan dengan ralat

time
Jenis: string | null

jumlah masa pelaksanaan, saat

version
Jenis: string | null

versi semasa API
application/json
400

Permintaan tidak dapat diproses. Semak parameter permintaan.
401

Kunci API Felo yang sah diperlukan.
402

Permintaan tidak dapat diteruskan kerana keperluan pengebilan tidak dipenuhi.
403

Akaun tidak dibenarkan melakukan operasi ini.
429

Had permintaan atau had perbelanjaan telah dicapai.
502

Perkhidmatan tidak dapat menyelesaikan permintaan.
503

API atau perkhidmatan pengebilan tidak tersedia buat sementara waktu.
504

Perkhidmatan tamat masa semasa memproses permintaan.
default

Respons ralat; respons passthrough huluan mungkin menggunakan format penyedia

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'

Tunjukkan Skema

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

Operasi berjaya

Ringkasan OnPage API

PengesahanRequired

DataForSEO

Ringkasan OnPage API

Rujukan harga