v0.2.0-beta

OpenAPI 3.1.0

Membuat Tugas OnPage

Felo API Support

MIT

Server

https://openapi.felo.ai

Pustaka Klien

Shell Curl

DataForSEO

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

DataForSEO Operasi

post/v1/beta/dataforseo/on_page/task_post

Membuat Tugas OnPage

Memulai crawl target dan mengembalikan id tugas di tasks[0].id - id itu adalah pegangan yang dibutuhkan setiap alat lain di keluarga ini, jadi simpanlah. max_crawl_pages membatasi crawl, start_url, max_crawl_depth, priority_urls, dan crawl_delay membentuknya, dan store_raw_html menentukan apakah post_dataforseo_on_page_raw_html akan punya sesuatu untuk disajikan nanti. Dibungkus dalam envelope DataForSEO: data di tasks[0].result, hasil di tasks[0].status_code - permintaan yang ditolak tetap mengembalikan HTTP 200. ⚠️ Ini bukan pasangan submit/fetch yang biasa: crawl adalah sesi yang kemudian ditanyakan oleh selusin alat lain berdasarkan id. Lakukan polling get_dataforseo_on_page_summary hingga crawl_progress terbaca finished; crawl satu halaman example.com memakan waktu jauh di bawah satu menit.

Referensi harga

Metering: Biaya respons yang dilaporkan.
Estimasi referensi per permintaan: USD 0.003.
Pengali pelanggan referensi: 1.0. Jangan terapkan lagi pada jumlah pelanggan yang telah diselesaikan.

Hanya metadata referensi, bukan penawaran akun, harga yang dijamin, atau batas pengeluaran. Kredit sumber daya bukanlah kredit Felo. Biaya akhir mengikuti catatan tagihan Felo.

Isi

application/json

Tipe: array (object | null)[]
- accept_language
 Tipe: string | null
 
 header bahasa untuk mengakses situs web
 field opsional
 semua format locale didukung (xx, xx-XX, xxx-XX, dll.)
 Catatan: jika Anda tidak menentukan parameter ini, beberapa situs web mungkin menolak akses; dalam hal ini, halaman akan dikembalikan dengan "type":"broken di array respons
- allow_subdomains
 Tipe: boolean | null
 
 sertakan halaman di subdomain
 field opsional
 setel ke true jika Anda ingin merayapi semua subdomain situs web target
 nilai default: false
- allowed_subdomains
 Tipe: array string[] | null
 
 subdomain yang akan dirayapi
 field opsional
 tentukan subdomain yang ingin Anda rayapi
 contoh: ["blog.site.com", "my.site.com", "shop.site.com"]
 Catatan: untuk menggunakan parameter ini, parameter allow_subdomains harus disetel ke false;
 jika tidak, konten field allowed_subdomains akan diabaikan dan hasil akan dikembalikan untuk semua subdomain
- browser_preset
 Tipe: string | null
 
 preset untuk parameter layar browser
 field opsional
 jika Anda menggunakan field ini, Anda tidak perlu menentukan browser_screen_width, browser_screen_height, browser_screen_scale_factornilai yang mungkin:
 desktop, mobile, tabletpreset desktop akan menerapkan nilai berikut:browser_screen_width: 1920
 browser_screen_height: 1080
 browser_screen_scale_factor: 1preset mobile akan menerapkan nilai berikut:browser_screen_width: 390
 browser_screen_height: 844
 browser_screen_scale_factor: 3preset tablet akan menerapkan nilai berikut:browser_screen_width: 1024
 browser_screen_height: 1366
 browser_screen_scale_factor: 2
 Catatan: untuk menggunakan parameter ini, setel enable_javascript atau enable_browser_rendering ke true
- browser_screen_height
 Tipe: integer | null
 
 tinggi layar browser
 field opsional
 Anda dapat menetapkan tinggi layar browser khusus untuk melakukan audit bagi perangkat tertentu;
 jika Anda menggunakan field ini, Anda tidak perlu menentukan browser_preset karena akan diabaikan;
 Catatan: untuk menggunakan parameter ini, setel enable_javascript atau enable_browser_rendering ke truenilai minimum, dalam piksel: 240
 nilai maksimum, dalam piksel: 9999
- browser_screen_scale_factor
 Tipe: number | null
 
 faktor skala layar browser
 field opsional
 Anda dapat menetapkan rasio resolusi layar browser khusus untuk melakukan audit bagi perangkat tertentu;
 jika Anda menggunakan field ini, Anda tidak perlu menentukan browser_preset karena akan diabaikan;
 Catatan: untuk menggunakan parameter ini, setel enable_javascript atau enable_browser_rendering ke truenilai minimum: 0.5
 nilai maksimum: 3
- browser_screen_width
 Tipe: integer | null Format: int64
 
 lebar layar browser
 field opsional
 Anda dapat menetapkan lebar layar browser khusus untuk melakukan audit bagi perangkat tertentu;
 jika Anda menggunakan field ini, Anda tidak perlu menentukan browser_preset karena akan diabaikan;
 Catatan: untuk menggunakan parameter ini, setel enable_javascript atau enable_browser_rendering ke truenilai minimum, dalam piksel: 240
 nilai maksimum, dalam piksel: 9999
- calculate_keyword_density
 Tipe: boolean | null
 
 hitung kepadatan kata kunci untuk domain target
 field opsional
 setel ke true jika Anda ingin menghitung kepadatan kata kunci untuk halaman situs web
 nilai default: false
 Catatan: jika Anda menggunakan parameter ini, biaya tambahan akan berlaku; pelajari lebih lanjut tentang biaya tugas dengan parameter ini di artikel bantuan kami
 setelah perayapan selesai, Anda dapat memperoleh nilai kepadatan kata kunci dengan endpoint Keyword Density
- check_spell
 Tipe: boolean | null
 
 periksa ejaan
 field opsional
 setel ke true untuk memeriksa ejaan di situs web menggunakan pustaka Hunspell
 nilai default: false
- check_spell_exceptions
 Tipe: array string[] | null
 
 kata yang dikecualikan dari pemeriksaan ejaan
 field opsional
 tentukan kata yang ingin Anda kecualikan dari pemeriksaan ejaan
 panjang kata maksimum: 100 karakter
 jumlah kata maksimum: 1000
 contoh: "SERP", "minifiers", "JavaScript"
- check_spell_language
 Tipe: string | null
 
 bahasa pemeriksaan ejaan
 field opsional
 bahasa yang didukung: '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'
 Catatan: jika tidak ada bahasa yang ditentukan, bahasa akan ditetapkan secara otomatis berdasarkan konten halaman
- checks_threshold
 Tipe: object | null
 
 nilai ambang khusus untuk pemeriksaan
 field opsional
 Anda dapat menentukan nilai ambang khusus untuk parameter yang disertakan dalam objek checks pada respons OnPage API;
 Catatan: hanya nilai ambang bilangan bulat yang dapat diubah;
 sebagai contoh, parameter high_loading_time dan large_page_size secara default disetel ke 3 detik dan 1 megabyte;
 jika Anda ingin mengubah ambang ini menjadi 1 detik dan 1000 kbyte, gunakan cuplikan berikut:
 "checks_threshold": { "high_loading_time": 1, "large_page_size": 1000 }
 parameter yang dapat disesuaikan beserta nilai default:
 "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
 Tipe: integer | null Format: int64
 
 Signed 64-bit integers (long type).
- crawl_delay
 Tipe: integer | null
 
 jeda antar-hit, ms
 field opsional
 jeda kustom antar-hit crawler ke server
 nilai default: 2000
- crawl_sitemap_only
 Tipe: boolean | null
 
 hanya rayapi halaman yang ditunjukkan dalam sitemap
 field opsional
 atur ke true jika Anda ingin merayapi hanya halaman yang ditunjukkan dalam sitemap
 jika Anda menetapkan parameter ini ke true dan tidak menentukan custom_sitemap, kami akan merayapi sitemap default
 nilai default: false
 Catatan: jika Anda ingin menggunakan parameter ini, respect_sitemap harus bernilai true
- custom_js
 Tipe: string | null
 
 javascript kustom
 field opsional
 Perhatikan bahwa waktu eksekusi skrip yang Anda masukkan di sini maksimal 700 ms, misalnya Anda dapat menggunakan cuplikan JS berikut untuk memeriksa apakah situs web berisi Google Tag Manager sebagai 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;nilai yang dikembalikan bergantung pada apa yang Anda tentukan di field ini. Misalnya, jika Anda menentukan skrip berikut:
 meta = {}; meta.url = document.URL; meta.test = 'test'; meta;
 sebagai respons Anda akan menerima data berikut:
 "custom_js_response": { "url": "https://dataforseo.com/", "test": "test" }
 Catatan: panjang skrip yang Anda masukkan tidak boleh lebih dari 2000 karakter
- custom_robots_txt
 Tipe: string | null
 
 pengaturan robots.txt kustom
 field opsional
 contoh: Disallow: /directory1/
- custom_sitemap
 Tipe: string | null
 
 URL sitemap kustom
 field opsional
 URL halaman tempat sitemap alternatif berada
 Catatan: jika Anda ingin menggunakan parameter ini, respect_sitemap harus bernilai true
- custom_user_agent
 Tipe: string | null
 
 user agent khusus
 field opsional
 user agent khusus untuk merayapi situs web
 contoh: 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
 nilai default: Mozilla/5.0 (compatible; RSiteAuditor)
- disable_cookie_popup
 Tipe: boolean | null
 
 nonaktifkan popup cookie
 field opsional
 atur ke true jika Anda ingin menonaktifkan popup yang meminta persetujuan cookie dari pengguna;
 nilai default:
 false
- disable_page_checks
 Tipe: array string[] | null
 
 cegah pemeriksaan halaman tertentu berjalan
 field opsional
 tentukan checks tertentu untuk mencegahnya berjalan dan memengaruhi onpage_scorecontoh:
 "disable_page_checks": ["is_5xx_code", "is_4xx_code"]
- disable_sitewide_checks
 Tipe: array string[] | null
 
 cegah pemeriksaan seluruh situs tertentu berjalan
 field opsional
 tentukan checks berikut untuk mencegahnya berjalan di situs web target:
 "test_page_not_found"
 "test_canonicalization"
 "test_https_redirect"
 "test_directory_browsing"contoh:
 "disable_sitewide_checks": ["test_directory_browsing", "test_page_not_found"]pelajari lebih lanjut di pusat bantuan kami
- disallowed_subdomains
 Tipe: array string[] | null
 
 subdomain yang tidak dirayapi
 field opsional
 tentukan subdomain yang tidak ingin Anda rayapi
 contoh: ["status.site.com", "docs.site.com"]
 Catatan: untuk menggunakan parameter ini, parameter allow_subdomains harus diatur ke true
- enable_browser_rendering
 Tipe: boolean | null
 
 emulasikan rendering browser untuk mengukur Core Web Vitals
 field opsional
 dengan menggunakan parameter ini Anda dapat mengemulasikan browser saat memuat halaman web;
 enable_browser_rendering memuat gaya, gambar, font, animasi, video, dan sumber daya lain di halaman;
 nilai default: false
 atur ke true untuk memperoleh metrik Core Web Vitals (FID, CLS, LCP) dalam respons;
 jika Anda menggunakan field ini, parameter enable_javascript dan load_resources harus diatur ke true
 Catatan: jika Anda menggunakan parameter ini, biaya tambahan akan berlaku; pelajari lebih lanjut tentang biaya tugas dengan parameter ini di artikel bantuan kami; biaya dapat dihitung di Halaman Harga
- enable_content_parsing
 Tipe: boolean | null
 
 parsing konten di halaman yang dirayapi
 field opsional
 atur ke true untuk menggunakan endpoint OnPage Content Parsing
 nilai default: false
- enable_javascript
 Tipe: boolean | null
 
 muat javascript di halaman
 field opsional
 atur ke true jika Anda ingin memuat skrip yang tersedia di halaman
 nilai default: false
 Catatan: jika Anda menggunakan parameter ini, biaya tambahan akan berlaku; pelajari lebih lanjut tentang biaya tugas dengan parameter ini di artikel bantuan kami; biaya dapat dihitung di Halaman Harga
- enable_www_redirect_check
 Tipe: boolean | null
 
 periksa apakah domain menerapkan pengalihan www
 field opsional
 atur ke true jika Anda ingin memeriksa apakah domain yang diminta menerapkan pengalihan www ke non-www atau non-www ke www;
 nilai default: false
- enable_xhr
 Tipe: boolean | null
 
 aktifkan XMLHttpRequest di halaman
 field opsional
 atur ke true jika Anda ingin crawler kami meminta data dari server web menggunakan objek XMLHttpRequest
 nilai default: false;jika Anda menggunakan field ini, enable_javascript harus diatur ke true;
- force_sitewide_checks
 Tipe: boolean | null
 
 aktifkan pemeriksaan seluruh situs saat merayapi satu halaman
 field opsional
 atur ke true untuk mendapatkan data tentang pemeriksaan seluruh situs saat merayapi satu halaman;
 nilai default: false
- load_resources
 Tipe: boolean | null
 
 muat sumber daya
 field opsional
 atur ke true jika Anda ingin memuat gambar, stylesheet, skrip, dan sumber daya yang rusak
 nilai default: false
 Catatan: jika Anda menggunakan parameter ini, biaya tambahan akan berlaku; pelajari lebih lanjut tentang biaya tugas dengan parameter ini di artikel bantuan kami; biaya dapat dihitung di Halaman Harga
- max_crawl_depth
 Tipe: integer | null
 
 kedalaman perayapan
 field opsional
 kedalaman tautan halaman yang akan dirayapi;
 misalnya, halaman awal perayapan adalah level 0, halaman yang memiliki tautan dari halaman tersebut adalah level 1, dan seterusnya.
- max_crawl_pages
 Tipe: integer
 
 batas halaman yang dirayapi
 field wajib
 jumlah halaman yang akan dirayapi pada domain yang ditentukan
 Catatan:
 jika Anda menetapkan max_crawl_pages ke 1 dan tidak menentukan start_url atau menetapkan halaman beranda di dalamnya, pemeriksaan seluruh situs berikut akan dinonaktifkan:
 test_canonicalization, enable_www_redirect_check, test_hidden_server_signature, test_page_not_found, test_directory_browsing, test_https_redirect
 untuk tetap mengaktifkannya, atur force_sitewide_checks ke truejika Anda menetapkan max_crawl_pages ke 1 dan menentukan start_url selain halaman beranda, semua pemeriksaan seluruh situs akan dinonaktifkan;
 untuk tetap mengaktifkannya, atur force_sitewide_checks ke true
- pingback_url
 Tipe: string | null
 
 URL notifikasi tugas yang selesai
 field opsional
 saat tugas selesai, kami akan memberi tahu Anda melalui permintaan GET yang dikirim ke URL yang Anda tentukan
 Anda dapat menggunakan string ‘$id’ sebagai variabel $id dan ‘$tag’ sebagai variabel $tag berenkode URL. Kami akan menyetel nilai yang diperlukan sebelum mengirim permintaan.
 contoh:
 http://your-server.com/pingscript?id=$id
 http://your-server.com/pingscript?id=$id&tag=$tag
 Catatan: karakter khusus dalam pingback_url akan dienkode URL;
 yaitu, karakter # akan dienkode menjadi %23
 
 pelajari lebih lanjut di Pusat Bantuan kami
- priority_urls
 Tipe: array string[] | null
 
 URL yang akan dirayapi dengan melewati antrean
 field opsional
 URL yang ditentukan dalam array ini akan dirayapi terlebih dahulu, melewati antrean perayapan;
 Catatan: Anda harus menentukan URL absolut;
 Anda dapat menentukan hingga 20 URL;
 semua URL dalam array harus termasuk dalam domain target;
 subdomain akan diabaikan kecuali parameter allow_subdomains diatur ke truecontoh:
 "priority_urls": [ "https://dataforseo.com/apis/serp-api", "https://dataforseo.com/contact" ]
- respect_sitemap
 Tipe: boolean | null
 
 patuhi sitemap saat merayapi
 field opsional
 atur ke true jika Anda ingin mengikuti urutan halaman yang ditunjukkan dalam sitemap utama saat merayapi;
 nilai default: false
 Catatan: jika diatur ke true, nilai click_depth dalam respons API akan sama dengan 0;
 field max_crawl_depth pada permintaan akan diabaikan, Anda dapat menentukan jumlah halaman yang akan dirayapi menggunakan parameter max_crawl_pages
- return_despite_timeout
 Tipe: boolean | null
 
 kembalikan data halaman meskipun terjadi error timeout
 field opsional
 jika true, data akan diberikan untuk halaman yang gagal dimuat dalam 120 detik dan merespons dengan error timeout;
 nilai default: false
- robots_txt_merge_mode
 Tipe: string | null
 
 gabungkan dengan atau timpa pengaturan robots.txt
 field opsional
 nilai yang mungkin: merge, override;
 atur ke override jika Anda ingin mengabaikan pembatasan perayapan situs web dan pengaturan robots.txt lainnya
 nilai default: merge;
 Catatan: jika diatur ke override, tentukan parameter custom_robots_txt
- start_url
 Tipe: string | null
 
 url pertama yang akan dirayapi
 field opsional
 Catatan: Anda harus menentukan URL absolut
 jika Anda ingin merayapi satu halaman, tentukan URL-nya di field ini dan sebagai tambahan atur parameter max_crawl_pages ke 1
 Anda juga dapat menggunakan endpoint Instant Pages langsung untuk mendapatkan data khusus halaman
- store_raw_html
 Tipe: boolean | null
 
 simpan HTML halaman yang dirayapi
 field opsional
 atur ke true jika Anda ingin mendapatkan HTML halaman menggunakan endpoint OnPage Raw HTML
 nilai default: false
- support_cookies
 Tipe: boolean | null
 
 dukung cookie pada halaman yang dirayapi
 field opsional
 atur ke true untuk mendukung cookie saat merayapi halaman
 nilai default: false
- switch_pool
 Tipe: boolean | null
 
 ganti kumpulan proxy
 field opsional
 jika true, kumpulan proxy tambahan akan digunakan untuk memperoleh data yang diminta;
 parameter ini dapat digunakan jika banyak tugas ditetapkan secara bersamaan, sehingga kadang terjadi error rate-limit dan/atau site_unreachable
- tag
 Tipe: string | null
 
 pengenal tugas yang ditentukan pengguna
 field opsional
 batas karakter adalah 255
 Anda dapat menggunakan parameter ini untuk mengidentifikasi tugas dan mencocokkannya dengan hasil
 Anda akan menemukan nilai tag yang ditentukan di objek data pada respons
- target
 Tipe: string
 
 domain target
 field wajib
 nama domain harus ditentukan tanpa https:// dan www.
 jika Anda menentukan URL halaman, hasil akan dikembalikan untuk domain yang tercantum dalam URL
- validate_micromarkup
 Tipe: boolean | null
 
 aktifkan validasi microdata
 field opsional
 atur ke true jika Anda ingin menggunakan endpoint OnPage API Microdata
 nilai default: false

Respons

200
Tipe: object | null · Response36Afe1097B20_OnPageTaskPostResponseInfo
cost
Tipe: number | null Format: double

total biaya tugas, USD

status_code
Tipe: integer | null

kode status umum; Anda dapat menemukan daftar lengkap kode respons di sini

status_message
Tipe: string | null

pesan informasi umum; Anda dapat menemukan daftar lengkap pesan informasi umum di sini

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

array tugas

Tipe: object | null · Response36Afe1097B20_OnPageTaskPostTaskInfo
cost
Tipe: number | null Format: double

total biaya tugas, USD

data
Tipe: object | null

berisi parameter yang sama dengan yang Anda tentukan dalam permintaan POST

propertyName
Tipe: object | null
id
Tipe: string | null

pengenal tugas; pengenal tugas unik di sistem kami dalam format UUID

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

Jalur URL

result
Tipe: object | null

array hasil
dalam kasus ini, nilainya akan menjadi null

result_count
Tipe: integer | null Format: int64

jumlah elemen dalam array hasil

status_code
Tipe: integer | null

kode status tugas yang dihasilkan oleh DataForSEO; dapat berada dalam rentang berikut: 10000-60000; Anda dapat menemukan daftar lengkap kode respons di sini

status_message
Tipe: string | null

pesan informasi tugas; Anda dapat menemukan daftar lengkap pesan informasi umum di sini

time
Tipe: string | null

waktu eksekusi, detik

tasks_count
Tipe: integer | null Format: int64

jumlah tugas dalam array tasks

tasks_error
Tipe: integer | null Format: int64

jumlah tugas dalam array tasks yang dikembalikan dengan error

time
Tipe: string | null

total waktu eksekusi, detik

version
Tipe: string | null

versi API saat ini
application/json
400

Permintaan tidak dapat diproses. Periksa parameter permintaan.
401

Kunci API Felo yang valid diperlukan.
402

Permintaan tidak dapat dilanjutkan karena persyaratan penagihan belum terpenuhi.
403

Akun tidak diizinkan melakukan operasi ini.
429

Batas permintaan atau batas pengeluaran telah tercapai.
502

Layanan tidak dapat menyelesaikan permintaan.
503

API atau layanan penagihan untuk sementara tidak tersedia.
504

Layanan kehabisan waktu saat memproses permintaan.
default

Respons error; respons passthrough upstream dapat menggunakan format penyedia

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

Tampilkan 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": null
    }
  ]
}

Operasi berhasil

Membuat Tugas OnPage

AutentikasiRequired

DataForSEO

Membuat Tugas OnPage

Referensi harga