Entegrasyonlar ve API

REST API

Skorlarınızı, soru sonuçlarınızı, kaynaklarınızı, aksiyonlarınızı, etki ölçümlerinizi ve denetimlerinizi bir kurum API anahtarıyla HTTPS üzerinden okuyun.

Rixe REST API'si salt okunur bir veri API'sidir. Uygulamada gördüğünüz sayıları bir panel aracına, veri ambarına ya da kendi betiklerinize verir: marka ve motor bazında günlük görünürlük, ses payı, kaynak gösterilen alan adları, aksiyon listesi, ölçülen etki ve teknik denetim bulguları. Rixe verisini Looker Studio, Power BI, bir tablo ya da gece çalışan bir dışa aktarım gibi başka bir yerde kullanmak istediğinizde işinize yarar.

API hesabınızda hiçbir şeyi değiştiremez. Rixe'nin API anahtarlarına açtığı tek yazma işlemi takip edilen sorulara soru eklemektir; o da bu API'nin değil, tarayıcı eklentisinin işidir.

Temel adres ve biçim

Temel adreshttps://api.rixe.ai/v1
BiçimJSON, UTF-8
YöntemTüm uç noktalarda GET
TarihlerYYYY-AA-GG, UTC
SözleşmeGET /v1/openapi.json (OpenAPI 3.1, anahtar ister)

Ondalıklı sayılar metin olarak gelir

Oranlar, güven aralığı sınırları, sıralar ve aksiyon puanları kesin ondalık olarak saklanır ve metin (string) olarak döner; örneğin "mentionRate": "0.6667". Grafiğe koymadan önce parseFloat (ya da aracınızdaki karşılığı) ile sayıya çevirin. runs ve mentions gibi sayımlar düz tam sayıdır.

Kimlik doğrulama

Her istek bir kurum API anahtarı ister. Anahtar rixe_ ile başlar ve iki başlıktan biriyle gönderilebilir:

bash
# 1. yol: bearer token
curl https://api.rixe.ai/v1/workspaces \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"

# 2. yol: x-api-key başlığı
curl https://api.rixe.ai/v1/workspaces \
  -H "x-api-key: rixe_ANAHTARINIZ"

Bir anahtar tek bir kuruma aittir ve o kurumdaki bütün çalışma alanlarını görür; uygulamanın kendisinin kullandığı satır düzeyi güvenlik (row-level security) burada da geçerlidir. İptal edilen anahtar bir sonraki istekte çalışmaz.

Anahtar oluşturma

  1. Kenar çubuğunun altındaki kullanıcı menüsünü açıp Ayarlar › Geliştirici bölümüne gidin.
  2. API anahtarları kartında API anahtarı ekle'ye tıklayın.
  3. Anahtar adı alanına nerede kullanılacağını yazın (örneğin "Looker Studio").
  4. Kapsamlar altında yalnızca aracın ihtiyaç duyduklarını işaretleyin. Hiçbirini işaretlemezseniz anahtar tüm okuma kapsamlarını alır.
  5. Anahtar üret'e tıklayın ve sarı uyarıdaki anahtarı kopyalayın. Anahtar yalnız şimdi gösterilir. Rixe yalnızca özetini (hash) saklar, anahtarı bir daha gösteremez.

Anahtarları yalnızca sahip ve yöneticiler oluşturup iptal edebilir. İptal etmek için listede anahtarın yanındaki İptal et'e tıklayın; anahtar hemen silinir ve listeden kalkar. Listede her anahtarın ön eki, kapsamları ve son kullanım zamanı da görünür.

Paket koşulu

API anahtarı oluşturmak, API erişimi olan ("REST API + MCP") bir paket gerektirir. Bu özelliği olmayan paketlerde Anahtar üret isteği reddedilir. Paket düşürüldüğünde mevcut anahtarlar çalışmaya devam eder, listelenebilir ve iptal edilebilir. Ayrıntılar: Paketler ve limitler.

Kapsamlar

Kapsam, bir anahtarın hangi uç noktaları okuyabileceğini belirler. Anahtarın kapsamı dışındaki bir istek 403 döner; eksik kapsamın adı mesajda yazar.

KapsamAçtığı erişim
read:scores/daily-scores, /sov (görünürlük skorları ve ses payı)
read:prompts/prompt-results (soru bazında sonuçlar)
read:sources/citations (kaynak haritası ve atıflar)
read:actions/actions (öncelikli iş listesi)
read:impact/impact (müdahaleler ve ölçülen etkileri)
read:audits/audits (teknik denetim bulguları)
read:knowledgeMCP üzerinden bilgi tabanı araması (MCP)
read:brandMCP üzerinden marka kiti bağlamı; eklentinin marka listesi
ask:assistantMCP üzerinden asistana soru sormak. Her cevap faturanıza yansıyan ücretli bir model çağrısıdır.
write:promptsTakip edilen sorulara soru eklemek (yalnızca tarayıcı eklentisi)
write:competitorsBir cevapta geçen markayı rakip olarak eklemek (yalnızca tarayıcı eklentisi)

/workspaces ve /openapi.json geçerli bir anahtar ister ama belirli bir kapsam istemez.

Her araca ayrı anahtar verin

Yalnızca skor grafiği çizen bir panele sadece read:scores kapsamlı bir anahtar yeter. Hiç kapsam işaretlenmemiş bir anahtar, aksiyon listeniz dahil her şeyi okuyabilir. Böyle bir anahtar ask:assistant, write:prompts ve write:competitors kapsamlarını hiçbir zaman içermez; bunlar her zaman ayrıca işaretlenmelidir.

İstek sınırı

API dakikada 1.200 isteğe izin verir. Bu aşılırsa 429 Too Many Requests döner; dakikanın dolmasını bekleyip artan aralıklarla yeniden deneyin. Ölçüm günlük yapıldığı için günde birkaç kereden sık sorgulamak aynı sayıları getirir. Sınıra bir panelden takılıyorsanız grafik sayısını değil, yenileme sıklığını düşürün.

Ortak sorgu parametreleri

ParametreTürAnlamı
workspaceIdUUIDTek bir çalışma alanıyla sınırlar. Kimliği /workspaces verir. Verilmezse anahtarın gördüğü tüm çalışma alanlarının satırları döner.
fromtarihPencerenin başlangıcı. Varsayılan: 30 gün önce.
totarihPencerenin sonu. Varsayılan: bugün (UTC).
limittam sayıDönecek satır sayısı, 1 ile 1000 arası. Varsayılan uç noktaya göre değişir.
offsettam sayıAtlanacak satır sayısı (/daily-scores üzerinde). Sayfalamak için limit ile birlikte kullanın.

Her uç nokta her parametreyi almaz; aşağıdaki başvuru bölümünde hangisinin neyi aldığı yazıyor.

Uç noktalar

GET /v1/workspaces

Anahtarın okuyabildiği çalışma alanları. workspaceId almak için buradan başlayın.

bash
curl https://api.rixe.ai/v1/workspaces -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
[
  { "id": "9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10", "name": "FlowCRM – US" }
]

GET /v1/daily-scores

Kapsam: read:scores. Parametreler: workspaceId, from, to, limit (varsayılan 500), offset.

Bütün grafiklerin üzerine kurulduğu günlük görünürlük serisi; en yeni gün en üstte. Her satır bir gün, bir marka (sizin markanız ya da takip ettiğiniz bir rakip) ve bir motordur. Satırlar konu bazında da tutulur ama konu cevapta yer almaz; bu yüzden aynı gün, marka ve motor birden fazla satırda görünebilir. Marka başına tek bir sayı istiyorsanız runs ve mentions değerlerini toplayın.

bash
curl "https://api.rixe.ai/v1/daily-scores?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10&from=2026-10-01&to=2026-10-24&limit=1000" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "date": "2026-10-24",
      "workspaceId": "9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10",
      "brand": "FlowCRM",
      "isCompetitor": false,
      "engine": "chatgpt-search",
      "runs": 6,
      "mentions": 4,
      "mentionRate": "0.6667",
      "ciLow": "0.3000",
      "ciHigh": "0.9032",
      "avgPosition": "2.250",
      "sov": "0.3100",
      "insufficient": false
    }
  ],
  "range": { "from": "2026-10-01", "to": "2026-10-24" },
  "count": 1
}
AlanAnlamı
runsO gün yapılan ölçüm sayısı (o motora sorulan sorular).
mentionsMarkayı anan cevap sayısı.
mentionRatementions / runs, 0 ile 1 arasında.
ciLow, ciHighmentionRate etrafındaki Wilson güven aralığı.
avgPositionMarkanın andığı cevaplardaki ortalama sırası; 1 en üst demektir.
sovMarkanın tüm marka anılmaları içindeki payı.
insufficientSatırın arkasında 4'ten az ölçüm varsa true. Bunu skor olarak değil, "yetersiz veri" olarak okuyun.
engineMotor kodu; örneğin chatgpt-search, perplexity-sonar, google-aio.

Yetersiz satırları ayıklayın

İki üç ölçümden çıkan bir oran sert dalgalanır ve gerçek bir değişim gibi görünür. Grafik çizmeden önce insufficient: true olan satırları çıkarın ya da "yetersiz veri" olarak gösterin. Ayrıntılar: Görünürlük skoru.

GET /v1/sov

Kapsam: read:scores. Parametreler: workspaceId, from, to.

Pencerenin tamamı için marka bazında ses payı: her markanın anılma sayısının tüm marka anılmalarına oranı.

bash
curl "https://api.rixe.ai/v1/sov?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    { "brand": "FlowCRM", "isCompetitor": false, "mentions": 212, "runs": 640, "sov": 0.3021, "insufficient": false },
    { "brand": "PipeHub", "isCompetitor": true, "mentions": 298, "runs": 640, "sov": 0.4245, "insufficient": false }
  ],
  "range": { "from": "2026-09-24", "to": "2026-10-24" }
}

Pencerede hiç anılma yoksa her sov değeri 0 olur. Bu eşit bölüşüm değil, "veri yok" demektir.

GET /v1/citations

Kapsam: read:sources. Parametreler: workspaceId, limit (varsayılan 200).

Motor cevaplarının kaynak gösterdiği alan adları; en çok gösterilen en üstte. Sayılar motor bazında tutulan aylık toplamlardır; bu yüzden bir alan adı birkaç satırda görünebilir, toplam için satırları toplayın. Bu uç noktada tarih filtresi yoktur.

bash
curl "https://api.rixe.ai/v1/citations?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10&limit=50" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "domain": "g2.com",
      "kind": "dizin",
      "access": "kayit",
      "citations": 87,
      "promptCoverage": 14,
      "brandMentioned": true
    }
  ],
  "count": 1
}

kind sabit bir kodla kaynak türüdür (örneğin haber, forum, yorum, dizin, pazaryeri, video, resmi, sosyal, bilinmiyor). access bir markanın o siteye nasıl girebileceğini söyler: kayit kayıt, basvuru başvuru, editoryel editoryal, sponsorlu sponsorlu, erisilemez erişilemez. promptCoverage, cevaplarında bu alan adı kaynak gösterilen farklı takip sorusu sayısıdır. brandMentioned, bu alan adını kaynak gösteren bir cevapta markanız anıldıysa true olur. Ayrıntılar: Kaynaklar.

GET /v1/actions

Kapsam: read:actions. Parametreler: workspaceId, status, limit (varsayılan 200).

Öncelik sırasına konmuş iş listesi, en yüksek puan en üstte. Örneğin bir ajans bunu kendi proje takip aracına çekebilir.

bash
curl "https://api.rixe.ai/v1/actions?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10&status=onerildi" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "id": "c0a4e3f1-6b7d-4f43-9a0e-1d2b3c4d5e6f",
      "kind": "bosluk",
      "title": "…",
      "description": "…",
      "suggestion": "…",
      "score": "8.400",
      "reason": "…",
      "status": "onerildi",
      "createdAt": "2026-10-20T03:12:44.120Z"
    }
  ],
  "count": 1
}

kind aksiyonun iç tür kodudur (örneğin bosluk: bir rakibin anılıp sizin anılmadığınız bir soru). title, description, suggestion ve reason uygulama için yazılır; hazır cümle yerine sözlük anahtarı içerebilir. status şunlardan biridir: onerildi (önerildi), planlandi (planlandı), yapildi (yapıldı) ya da yoksayildi (yok sayıldı). Ayrıntılar: Aksiyon planı.

GET /v1/impact

Kapsam: read:impact. Parametreler: workspaceId.

Kaydettiğiniz değişiklikler (müdahaleler), en yenisi en üstte ve en fazla 200 tane; her biri ölçülen etkileriyle birlikte.

bash
curl "https://api.rixe.ai/v1/impact?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "id": "5d2e8a90-1f3b-4c6d-8e7f-a1b2c3d4e5f6",
      "kind": "icerik-yayini",
      "title": "Fiyat karşılaştırma sayfası yayınlandı",
      "appliedAt": "2026-09-02T09:00:00.000Z",
      "effects": [
        { "interventionId": "5d2e8a90-1f3b-4c6d-8e7f-a1b2c3d4e5f6", "weeks": 4, "delta": "0.0810", "significant": true, "reason": "significant" }
      ]
    }
  ],
  "count": 1
}

delta, müdahaleden sonra anılma oranındaki değişimdir. reason şunlardan biridir: significant, too-small, insufficient-sample ya da not-significant. Ayrıntılar: Etki ölçümü.

GET /v1/audits

Kapsam: read:audits. Parametreler: workspaceId, limit (varsayılan 50).

Teknik denetim sonuçları, en yenisi en üstte. kind site denetimi için tech, Bing hazırlık paketi için bing olur; findings uygulamada gösterilen bulguların listesidir.

bash
curl "https://api.rixe.ai/v1/audits?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10&limit=5" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
      "url": "https://flowcrm.io",
      "kind": "tech",
      "score": 82,
      "findings": [],
      "createdAt": "2026-10-23T02:05:10.000Z"
    }
  ],
  "count": 1
}

Ayrıntılar: Site sağlığı.

GET /v1/prompt-results

Kapsam: read:prompts. Parametreler: workspaceId, from (varsayılan 30 gün önce), limit (varsayılan 500).

Ölçülen her cevap ve marka için bir satır: ne soruldu, hangi motorda ve marka geçti mi. Skorların ham maddesi budur.

bash
curl "https://api.rixe.ai/v1/prompt-results?workspaceId=9b1f6c2e-4d1a-4f0e-8a51-2f3c7d9e1a10&from=2026-10-20&limit=1000" \
  -H "Authorization: Bearer rixe_ANAHTARINIZ"
json
{
  "data": [
    {
      "date": "2026-10-24T04:00:00.000Z",
      "prompt": "Beş kişilik bir satış ekibi için en iyi CRM hangisi?",
      "engine": "perplexity-sonar",
      "brand": "FlowCRM",
      "mentioned": true,
      "position": 2,
      "sentiment": "positive"
    }
  ],
  "count": 1
}

Marka anılmadıysa position değeri null olur. sentiment şunlardan biridir: positive, neutral, negative. Ayrıntılar: Sorular.

Hatalar

Hatalar standart HTTP durum kodlarıyla ve JSON gövdeyle döner:

json
{ "statusCode": 403, "message": "This API key is missing the \"read:actions\" scope", "error": "Forbidden" }
DurumAnlamıNe yapmalı
401 API key requiredAnahtar yok ya da değer rixe_ ile başlamıyor.Anahtarı Authorization: Bearer ya da x-api-key başlığında gönderin.
401 Invalid API keyAnahtar tanınmıyor ya da iptal edilmiş.Yeni bir anahtar oluşturun.
403Anahtarda bu uç noktanın istediği kapsam yok.O kapsamı içeren bir anahtar oluşturun.
429İstek sınırı aşıldı.Bekleyip yeniden deneyin; daha seyrek sorgulayın.

Sık sorulanlar

Aynı marka aynı gün neden iki kez görünüyor? /daily-scores marka ve motorun yanı sıra konu bazında da satır tutar. Tek bir oran için runs ve mentions değerlerini toplayıp birbirine bölün.

Son gün neden yok? Ölçüm günlük yapılır. Bugünün satırı, o günün ölçümleri skorlandıktan sonra görünür.

API üzerinden veri yazabilir miyim? Hayır. Veri API'si salt okunurdur.

İlgili sayfalar

Takıldığınız bir yer mi var? [email protected] adresine yazın, bir kişi cevap verir.