API Hop

Belgeler

API Hop Belgeleri

SimilarwebAPI

Kimliği doğrulanmış REST uç noktalarıyla web sitesi trafiğini, arama anahtar kelimelerini, geri bağlantıları, yönlendirmeleri, rakipleri ve etkileşimi sorgulayın.

SimilarwebAPI, /v1/similarweb altında 27 salt okunur veri uç noktası sunar. Diğer RequestBeam API’leriyle aynı hesabı, API anahtarını, bakiyeyi ve kullanım geçmişini kullanın. Kullanılabilirlik etkin bir ağ geçidine ve API anahtarı izinlerinize bağlıdır; belgeler üretim ortamında kullanılabilirliği doğrulamaz.

Kimlik doğrulama

Üçüncü taraf kimlik bilgisi yerine RequestBeam API anahtarınızı gönderin:

http
Authorization: Bearer YOUR_API_KEY

İstek örneği

Tüm genel işlemler sorgu parametreleriyle ve istek gövdesi olmadan GET kullanır. Yol ve parametrelerin büyük/küçük harflerini belgede gösterildiği gibi koruyun.

Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür.

Tarih kabul eden uç noktalarda geçerli ve eksiksiz açık bir from/to aralığı önceliklidir. Uç nokta latest kabul ediyorsa gönderilen değer mevcut biçim ve uç noktaya özgü doğrulamalardan yine geçmelidir; ancak aralık seçiminde yok sayılır ve Similarweb'e gönderilmez, varsayılan latest de eklenmez. Açık bir aralık yoksa mevcut latest, varsayılan değer ve pencere davranışı değişmez. History kısıtlamaları geçerliliğini korur; latest kabul etmeyen uç noktalar bu alanı reddetmeye devam eder.

bash
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

Gelen yönlendirmeler keys yerine küçük harfli tek bir key ana makine adı kullanır. Bu key, hedef web sitesi için bir iş sorgusu parametresidir, API kimlik bilgisi değildir; yalnızca açıkça izin verilen Similarweb GET rotalarında kullanılabilir. API kimlik doğrulaması hâlâ Authorization kullanır ve diğer kimlik bilgisi sorgu alanları yasaktır. Satırlar Data değil Records içinde döndürülür. Her işlemin tam alanları için eksiksiz uç nokta başvurusuna bakın.

Kapsam

  • Arama: anahtar kelime önerileri, sıralama sayfaları, web sitesi anahtar kelimeleri, organik ve ücretli arama, markalı anahtar kelimeler.
  • Web sitesi trafiği: etkileşim, ziyaretler, coğrafya, cihaz dağılımı, kanallar ve sosyal trafik.
  • İlişkiler: geri bağlantılar, gelen yönlendirmeler, giden trafik ve benzer web siteleri.
  • Geçmiş: aylık ziyaret, hemen çıkma oranı, ziyaret süresi ve ziyaret başına sayfa sayısının ayrı serileri.

Yanıtlar

Başarılı yanıtlar yeni bir success/data zarfı eklenmeden yerel JSON gövdesini korur. Alan adları, bilinmeyen alanlar, boş diziler ve sayısal hassasiyet değişmez. Farklı uç noktalar Data, Records veya başka bir yerel yapı döndürebilir; ortak bir satır alanı varsaymayın.

Başarılı boş sonuç, alan adının trafiği olmadığı anlamına gelmez. Başarısız istekler boş veri olarak ele alınmamalıdır. Sorun giderme için X-Request-Id ve istek zamanını saklayın.

Faturalandırma ve sayfalama

27 uç noktanın tamamında standart fiyat başarılı istek başına $0.0005, yani 1,000 istek başına $0.50 tutarındadır. Faturalandırma satır değil istek başınadır; başarılı boş sonuç da bir istek sayılır. Sonraki her sayfa ayrı bir istektir. Yapılandırılmışsa hesaba özel fiyatlandırma önceliklidir. Geçersiz parametre, eksik yetkilendirme veya yetersiz bakiye içeren istekler başarılı ücretlendirilebilir çağrı olarak ilerlemez. Üst sağlayıcıda başarısız olan istekler ücretlendirilmez.

Platformun asgari bakiye ilkesi gereğince çağrı öncesinde hesabınızda en az $0.10 kullanılabilir bakiye olmalıdır. Standart ücret başarılı istek başına $0.0005 olarak kalır.

Yalnızca seçilen uç nokta için belgelenen sayfalama alanlarını kullanın. Sayfalama genellikle 1’den başlar; geri bağlantılar Page ve PageSize, diğer tablolar ise page, pageSize veya rowsPerPage kullanabilir. Desteklenmeyen sayfa boyutu alanlarını göndermeyin.

Hatalar

Platform hataları aşağıdaki yapıyı kullanır; code, HTTP durumu değil platform iş kodudur:

json
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

Yaygın HTTP durumları 400 geçersiz sorgu, 401 geçersiz API anahtarı, 402 yetersiz bakiye, 403 ağ geçidi erişimi reddi, 429 hız sınırı ve 5xx geçici üst sağlayıcı veya hizmet hatasıdır. Hatalı biçimlendirilmiş istekleri değiştirmeden yeniden denemeyin.