Docs
Cari dokumen...⌘K

Batas konsumsi

Ahrefs API tersedia pada paket berbayar yang memenuhi syarat. Di semua paket lainnya, Anda tetap akan memiliki akses ke sekumpulan kueri uji gratis yang terbatas.

Semua permintaan selain kueri uji gratis serta endpoint Rank Tracker, Management, Public, dan sebagian lainnya menghabiskan unit API. Jika suatu endpoint gratis, Anda akan melihat catatan tentang hal itu di halaman dokumentasinya; jika tidak, endpoint tersebut menghabiskan unit.

Konsumsi unit per permintaan dihitung sebagai berikut:

max(base_cost, per_row_cost * num_rows)

base_cost untuk setiap permintaan adalah 50 unit. per_row_cost adalah jumlah biaya dari setiap field unik yang muncul baik pada hasil yang dikembalikan, maupun pada parameter where atau order_by. Jika sebuah field muncul di beberapa parameter, field tersebut dihitung satu kali.

Biaya default sebuah field adalah 1 unit. Namun, metrik tertentu lebih mahal dan dapat menghabiskan 5 atau 10 unit. Pengecualian seperti ini dicantumkan dalam deskripsi field di setiap endpoint. Permintaan yang dilayani dari cache tidak menghabiskan unit.

Setiap permintaan API menunjukkan perilaku konsumsi unitnya melalui header respons berikut:

  • x-api-rows Jumlah baris yang dikembalikan.
  • x-api-units-cost-row Biaya unit per baris.
  • x-api-units-cost-total Total unit yang seharusnya dikonsumsi oleh permintaan berdasarkan jumlah baris dan biaya per baris.
  • x-api-units-cost-total-actual Total unit yang benar-benar dikonsumsi oleh permintaan.
  • x-api-cache Apakah permintaan dilayani dari cache. Salah satu dari: hit miss no_cache

info

Cara yang baik untuk memperkirakan biaya sebuah permintaan adalah dengan menjalankannya menggunakan target gratis dan memeriksa nilai field x-api-units-cost-total. Untuk menampilkan header respons saat menggunakan perintah curl, Anda dapat menggunakan opsi -v atau --verbose.

Contoh 1

Pertimbangkan sebuah permintaan ke endpoint Site Explorer - Peringkat Domain (/site-explorer/domain-rating).

Endpoint ini tidak menerima parameter select, where, atau order_by, dan mengembalikan satu baris yang berisi dua field - domain_rating dan ahrefs_rank, dengan biaya per baris sebesar 2 unit.

Total biaya baris (biaya per baris dikalikan jumlah baris) lebih rendah daripada biaya dasar. Karena itu, permintaan ini dikenakan biaya dasar sebesar 50 unit.

Contoh 2

Pertimbangkan permintaan yang lebih kompleks ke endpoint Site Explorer - Backlinks (/site-explorer/all-backlinks), yang memungkinkan konfigurasi parameter select, where, dan order_by.

Misalkan permintaan ini memilih dua field:

select=title,traffic

dua field dalam ekspresi filter:

where={"and":[{"field":"traffic","is":["gt",1000]},{"field":"refdomains_source","is":["gt",10]}]}

serta sebuah field pengurutan:

order_by=traffic:desc

Di antara parameter-parameter ini, terdapat tiga field unik, di mana title dan refdomains_source masing-masing berbiaya 1 unit, sedangkan traffic berbiaya 10 unit. Dengan demikian, biaya per baris adalah 1 + 1 + 10 = 12 unit.

Misalkan permintaan tersebut mengembalikan 500 baris. Maka, total biaya baris (12 * 500 = 6000 unit) melebihi biaya dasar. Karena itu, biaya permintaan ini adalah 6000 unit.