Ana içeriğe atla
Perquery API’si, kodunuza organizasyonunuzun verilerini okuma erişimi verir. Perquery verilerini kendi raporlarınıza, panolarınıza veya veri ambarınıza aktarmak için API’yi kullanın.

​
Gerekenler

​
Temel URL

Tüm istekler bu temel URL’ye gider:
Tüm yollar /v1 ile başlar. Örneğin sitelerinizin listesi https://perquery.ai/api/v1/sites adresindedir.
Bir yolun sonuna eğik çizgi eklemeyin. API, /v1/sites/ için 404 yanıtı verir.

​
Temel kurallar

  • Salt okunur. API yalnızca GET isteklerini kabul eder. Başka bir yöntemle gönderilen istek 403 yanıtı alır.
  • JSON. API yanıtları JSON olarak gönderir. Hata yanıtları application/problem+json kullanır. Hatalar ve limitler sayfasını okuyun.
  • Her istekte API anahtarı. Anahtarınızı Authorization başlığında gönderin. Kimlik doğrulama sayfasını okuyun.
  • Anahtarı oluşturanla aynı erişim. Bir anahtar yalnızca, istek anında oluşturucusunun rollerinin izin verdiği verileri okur.
  • UUID’ler. Sitelerin, promptların ve diğer kaynakların bir UUID’si vardır. Yollar bu UUID’yi kullanır, örneğin /v1/sites/{site_uuid}/prompts.

​
Neleri okuyabilirsiniz

Bir API anahtarı bu veri türlerini okuyabilir:
  • Siteleriniz, promptlarınız, personalarınız ve rakipleriniz.
  • Görünürlük taramalarının sonuçları ve AI motorlarının yanıtları.
  • İçerik analizi, teknik analiz, otorite ve bot logları sonuçları.
  • Fırsatlar ve etki takibi.
  • Entegrasyonlarınızın durumu.
Bir API anahtarı hesap, ekip veya faturalandırma verilerini okuyamaz ve değiştiremez. Bunlar için Perquery uygulamasını kullanın.

​
İlk isteğiniz

1

Bir API anahtarı oluşturun

Uygulamadaki API Anahtarları sayfasında bir anahtar oluşturun. Uygulama anahtarı gösterdiğinde kopyalayın. API anahtarları sayfasını okuyun.
2

Bir istek gönderin

pq_xxxxxxxxxxxx_gizli_anahtariniz değerini kendi anahtarınızla değiştirin. Bu komutu çalıştırın:
3

Yanıtı okuyun

API, bir JSON nesnesiyle 200 yanıtı verir. sites listesi organizasyonunuzun sitelerini içerir. Diğer endpoint’lerin yollarında bir sitenin uuid değerini kullanın.

​
Önbelleğe alınan yanıtlar

Bazı endpoint’ler bir ETag başlığı gönderir. Bu değeri sonraki isteğin If-None-Match başlığında geri gönderin. Veri değişmediyse API gövdesiz bir 304 yanıtı verir.

​
Endpoint referansı

API referansı sekmesindeki Endpoints grubu her endpoint’i parametreleri ve yanıtıyla birlikte listeler.

​
İlgili sayfalar