PushizoDocs

Site içi arama

Site içi arama — 11 işlem (GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings, GET /v1/apps/{appId}/site-search/sources, …). OpenAPI 3.1.0 sözleşmesinden üretilir.

Web sitesine gömülen arama: taranan veya API ile yüklenen içerik dizini, kaynaklar ve tarama durumu, ayarlar (AI yanıtı, köken listesi, aylık token tavanı) ve sorgu raporu. Ziyaretçi araması Web SDK üzerinden anahtarsız SDK ucuyla yapılır. Growth+ planı gerekir.

Taban adres: https://api.pushizo.com · Etiket: site-search · Etkileşimli belge (Scalar)

İşlemler

YöntemYolİşlem
GET/v1/apps/{appId}/site-searchSite araması ayarları, dizin durumu ve AI kullanımı
PATCH/v1/apps/{appId}/site-search/settingsSite araması ayarlarını güncelle
GET/v1/apps/{appId}/site-search/sourcesArama kaynakları
POST/v1/apps/{appId}/site-search/sourcesArama kaynağı ekle
PATCH/v1/apps/{appId}/site-search/sources/{sourceId}Arama kaynağını düzenle
DELETE/v1/apps/{appId}/site-search/sources/{sourceId}Arama kaynağını ve sayfalarını sil
POST/v1/apps/{appId}/site-search/sources/{sourceId}/crawlKaynağı şimdi yeniden tara
GET/v1/apps/{appId}/site-search/documentsDizindeki belgeler
PUT/v1/apps/{appId}/site-search/documents/{documentKey}Belgeyi dizine yükle veya değiştir (anahtar app içinde tekildir)
DELETE/v1/apps/{appId}/site-search/documents/{documentKey}Belgeyi dizinden sil (belge kimliği veya anahtarı)
GET/v1/apps/{appId}/site-search/reportArama raporu

Ayrıntılar

GET/v1/apps/{appId}/site-searchDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SiteSearchOverview

AlanTürZorunluAçıklama
settingsobjectEvet
settings.enabledbooleanEvet
settings.ai_answersbooleanEvet
settings.allowed_originsarray<string>Evet
settings.languagestringEvet
settings.text_search_configstringEvet
settings.monthly_token_capintegerEvet
settings.query_retention_daysintegerEvet
settings.updated_atstring | nullEvet
indexobjectEvet
index.documentsintegerEvet
index.chunksintegerEvet
index.sourcesintegerEvet
index.last_indexed_atstring | nullEvet
usageobjectEvet
usage.tokens_this_monthintegerEvet
usage.monthly_token_capintegerEvet
usage.period_startstringEvet
aiobjectEvet
ai.availablebooleanEvet
ai.reasonenum | nullEvet

Örnek yanıt:

{
  "settings": {
    "enabled": true,
    "ai_answers": true,
    "allowed_origins": [
      "örnek"
    ],
    "language": "tr",
    "text_search_config": "örnek",
    "monthly_token_cap": 1,
    "query_retention_days": 1,
    "updated_at": "örnek"
  },
  "index": {
    "documents": 1,
    "chunks": 1,
    "sources": 1,
    "last_indexed_at": "örnek"
  },
  "usage": {
    "tokens_this_month": 1,
    "monthly_token_cap": 1,
    "period_start": "örnek"
  },
  "ai": {
    "available": true,
    "reason": "disabled"
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Site araması ayarlarını güncelle

PATCH/v1/apps/{appId}/site-search/settingsDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: UpdateSiteSearchSettingsDto

AlanTürZorunluAçıklama
enabledbooleanHayır
ai_answersbooleanHayır
allowed_originsarray<string>HayırÖğe: 0–20
languagestringHayır
monthly_token_capintegerHayırAralık: 1000–50000000
query_retention_daysintegerHayırAralık: 7–365

Örnek:

{
  "enabled": true,
  "ai_answers": true,
  "allowed_origins": [
    "örnek"
  ],
  "language": "tr",
  "monthly_token_cap": 1000
}

Yanıtlar

200 — Başarılı.

Şema: SiteSearchOverview

AlanTürZorunluAçıklama
settingsobjectEvet
settings.enabledbooleanEvet
settings.ai_answersbooleanEvet
settings.allowed_originsarray<string>Evet
settings.languagestringEvet
settings.text_search_configstringEvet
settings.monthly_token_capintegerEvet
settings.query_retention_daysintegerEvet
settings.updated_atstring | nullEvet
indexobjectEvet
index.documentsintegerEvet
index.chunksintegerEvet
index.sourcesintegerEvet
index.last_indexed_atstring | nullEvet
usageobjectEvet
usage.tokens_this_monthintegerEvet
usage.monthly_token_capintegerEvet
usage.period_startstringEvet
aiobjectEvet
ai.availablebooleanEvet
ai.reasonenum | nullEvet

Örnek yanıt:

{
  "settings": {
    "enabled": true,
    "ai_answers": true,
    "allowed_origins": [
      "örnek"
    ],
    "language": "tr",
    "text_search_config": "örnek",
    "monthly_token_cap": 1,
    "query_retention_days": 1,
    "updated_at": "örnek"
  },
  "index": {
    "documents": 1,
    "chunks": 1,
    "sources": 1,
    "last_indexed_at": "örnek"
  },
  "usage": {
    "tokens_this_month": 1,
    "monthly_token_cap": 1,
    "period_start": "örnek"
  },
  "ai": {
    "available": true,
    "reason": "disabled"
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/settings" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "ai_answers": true,
  "allowed_origins": [
    "örnek"
  ],
  "language": "tr",
  "monthly_token_cap": 1000
}'

Arama kaynakları

GET/v1/apps/{appId}/site-search/sourcesDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SiteSearchSourceList

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].namestringEvet
data[].kindenumEvetDeğerler: "sitemap", "urls"
data[].urlstring | nullEvet
data[].urlsarray<string>Evet
data[].max_pagesintegerEvet
data[].refresh_hoursinteger | nullEvet
data[].enabledbooleanEvet
data[].statusenumEvetDeğerler: "idle", "queued", "crawling", "ok", "partial", "failed"
data[].documentsintegerEvet
data[].crawl_requested_atstring | nullEvet
data[].last_crawled_atstring | nullEvet
data[].next_crawl_atstring | nullEvet
data[].last_errorstring | nullEvet
data[].statsobjectEvet
data[].stats.pages_foundintegerEvet
data[].stats.pages_indexedintegerEvet
data[].stats.pages_unchangedintegerEvet
data[].stats.pages_skippedintegerEvet
data[].stats.pages_failedintegerEvet
data[].stats.pages_removedintegerEvet
data[].stats.duration_msintegerEvet
data[].created_atstringEvet
data[].updated_atstringEvet

Örnek yanıt:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "url": "https://pushizo.com/orders/1001",
      "enabled": true,
      "status": "idle",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "kind": "sitemap",
      "urls": [
        "https://pushizo.com/orders/1001"
      ],
      "max_pages": 1,
      "refresh_hours": 1,
      "documents": 1,
      "crawl_requested_at": "örnek",
      "last_crawled_at": "örnek",
      "next_crawl_at": "örnek",
      "last_error": "örnek",
      "stats": {
        "pages_found": 1,
        "pages_indexed": 1,
        "pages_unchanged": 1,
        "pages_skipped": 1,
        "pages_failed": 1,
        "pages_removed": 1,
        "duration_ms": 1
      },
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Arama kaynağı ekle

POST/v1/apps/{appId}/site-search/sourcesDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: CreateSiteSearchSourceDto

AlanTürZorunluAçıklama
namestringEvetUzunluk: 1–80
kindenumEvetDeğerler: "sitemap", "urls"
urlstringHayırUzunluk: 0–2000
urlsarray<string>HayırÖğe: 1–500
max_pagesintegerHayırAralık: 1–2000
refresh_hoursinteger | nullHayır
enabledbooleanHayır

Örnek:

{
  "name": "Sipariş bildirimleri",
  "kind": "sitemap",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "urls": [
    "https://pushizo.com/orders/1001"
  ],
  "max_pages": 1,
  "refresh_hours": 1
}

Yanıtlar

201 — Başarılı.

Şema: SiteSearchSource

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "sitemap", "urls"
urlstring | nullEvet
urlsarray<string>Evet
max_pagesintegerEvet
refresh_hoursinteger | nullEvet
enabledbooleanEvet
statusenumEvetDeğerler: "idle", "queued", "crawling", "ok", "partial", "failed"
documentsintegerEvet
crawl_requested_atstring | nullEvet
last_crawled_atstring | nullEvet
next_crawl_atstring | nullEvet
last_errorstring | nullEvet
statsobjectEvet
stats.pages_foundintegerEvet
stats.pages_indexedintegerEvet
stats.pages_unchangedintegerEvet
stats.pages_skippedintegerEvet
stats.pages_failedintegerEvet
stats.pages_removedintegerEvet
stats.duration_msintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "status": "idle",
  "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "kind": "sitemap",
  "urls": [
    "https://pushizo.com/orders/1001"
  ],
  "max_pages": 1,
  "refresh_hours": 1,
  "documents": 1,
  "crawl_requested_at": "örnek",
  "last_crawled_at": "örnek",
  "next_crawl_at": "örnek",
  "last_error": "örnek",
  "stats": {
    "pages_found": 1,
    "pages_indexed": 1,
    "pages_unchanged": 1,
    "pages_skipped": 1,
    "pages_failed": 1,
    "pages_removed": 1,
    "duration_ms": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "kind": "sitemap",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "urls": [
    "https://pushizo.com/orders/1001"
  ],
  "max_pages": 1,
  "refresh_hours": 1
}'

Arama kaynağını düzenle

PATCH/v1/apps/{appId}/site-search/sources/{sourceId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
sourceIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: UpdateSiteSearchSourceDto

AlanTürZorunluAçıklama
namestringHayırUzunluk: 1–80
kindenumHayırDeğerler: "sitemap", "urls"
urlstringHayırUzunluk: 0–2000
urlsarray<string>HayırÖğe: 1–500
max_pagesintegerHayırAralık: 1–2000
refresh_hoursinteger | nullHayır
enabledbooleanHayır

Örnek:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "kind": "sitemap",
  "urls": [
    "https://pushizo.com/orders/1001"
  ]
}

Yanıtlar

200 — Başarılı.

Şema: SiteSearchSource

AlanTürZorunluAçıklama
idstringEvet
namestringEvet
kindenumEvetDeğerler: "sitemap", "urls"
urlstring | nullEvet
urlsarray<string>Evet
max_pagesintegerEvet
refresh_hoursinteger | nullEvet
enabledbooleanEvet
statusenumEvetDeğerler: "idle", "queued", "crawling", "ok", "partial", "failed"
documentsintegerEvet
crawl_requested_atstring | nullEvet
last_crawled_atstring | nullEvet
next_crawl_atstring | nullEvet
last_errorstring | nullEvet
statsobjectEvet
stats.pages_foundintegerEvet
stats.pages_indexedintegerEvet
stats.pages_unchangedintegerEvet
stats.pages_skippedintegerEvet
stats.pages_failedintegerEvet
stats.pages_removedintegerEvet
stats.duration_msintegerEvet
created_atstringEvet
updated_atstringEvet

Örnek yanıt:

{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "status": "idle",
  "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "kind": "sitemap",
  "urls": [
    "https://pushizo.com/orders/1001"
  ],
  "max_pages": 1,
  "refresh_hours": 1,
  "documents": 1,
  "crawl_requested_at": "örnek",
  "last_crawled_at": "örnek",
  "next_crawl_at": "örnek",
  "last_error": "örnek",
  "stats": {
    "pages_found": 1,
    "pages_indexed": 1,
    "pages_unchanged": 1,
    "pages_skipped": 1,
    "pages_failed": 1,
    "pages_removed": 1,
    "duration_ms": 1
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "url": "https://pushizo.com/orders/1001",
  "enabled": true,
  "kind": "sitemap",
  "urls": [
    "https://pushizo.com/orders/1001"
  ]
}'

Arama kaynağını ve sayfalarını sil

DELETE/v1/apps/{appId}/site-search/sources/{sourceId}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
sourceIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: Ok

AlanTürZorunluAçıklama
oktrueEvet

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Kaynağı şimdi yeniden tara

POST/v1/apps/{appId}/site-search/sources/{sourceId}/crawlDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
sourceIdyolstringEvet"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SiteSearchCrawlRequest

AlanTürZorunluAçıklama
queuedbooleanEvet
sourceobjectEvet
source.idstringEvet
source.namestringEvet
source.kindenumEvetDeğerler: "sitemap", "urls"
source.urlstring | nullEvet
source.urlsarray<string>Evet
source.max_pagesintegerEvet
source.refresh_hoursinteger | nullEvet
source.enabledbooleanEvet
source.statusenumEvetDeğerler: "idle", "queued", "crawling", "ok", "partial", "failed"
source.documentsintegerEvet
source.crawl_requested_atstring | nullEvet
source.last_crawled_atstring | nullEvet
source.next_crawl_atstring | nullEvet
source.last_errorstring | nullEvet
source.statsobjectEvet
source.stats.pages_foundintegerEvet
source.stats.pages_indexedintegerEvet
source.stats.pages_unchangedintegerEvet
source.stats.pages_skippedintegerEvet
source.stats.pages_failedintegerEvet
source.stats.pages_removedintegerEvet
source.stats.duration_msintegerEvet
source.created_atstringEvet
source.updated_atstringEvet

Örnek yanıt:

{
  "queued": true,
  "source": {
    "name": "Sipariş bildirimleri",
    "url": "https://pushizo.com/orders/1001",
    "enabled": true,
    "status": "idle",
    "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "kind": "sitemap",
    "urls": [
      "https://pushizo.com/orders/1001"
    ],
    "max_pages": 1,
    "refresh_hours": 1,
    "documents": 1,
    "crawl_requested_at": "örnek",
    "last_crawled_at": "örnek",
    "next_crawl_at": "örnek",
    "last_error": "örnek",
    "stats": {
      "pages_found": 1,
      "pages_indexed": 1,
      "pages_unchanged": 1,
      "pages_skipped": 1,
      "pages_failed": 1,
      "pages_removed": 1,
      "duration_ms": 1
    },
    "created_at": "örnek",
    "updated_at": "örnek"
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/crawl" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Dizindeki belgeler

GET/v1/apps/{appId}/site-search/documentsDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
source_idsorgustringHayırUzunluk: 0–60"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
qsorgustringHayırUzunluk: 0–200"ayse"
limitsorguintegerHayırAralık: 1–10050
cursorsorgustringHayır"eyJpZCI6Im1zZ18wMUpE…"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SiteSearchDocumentPage

AlanTürZorunluAçıklama
dataarray<object>Evet
data[].idstringEvet
data[].keystringEvet
data[].source_idstring | nullEvet
data[].urlstringEvet
data[].titlestringEvet
data[].languagestring | nullEvet
data[].chunksintegerEvet
data[].charsintegerEvet
data[].indexed_atstringEvet
data[].created_atstringEvet
next_cursorstring | nullEvet
has_morebooleanEvet

Örnek yanıt:

{
  "data": [
    {
      "url": "https://pushizo.com/orders/1001",
      "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "key": "key-2026-10",
      "source_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "title": "Siparişiniz yola çıktı",
      "language": "tr",
      "chunks": 1,
      "chars": 1,
      "indexed_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/documents?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Belgeyi dizine yükle veya değiştir (anahtar app içinde tekildir)

PUT/v1/apps/{appId}/site-search/documents/{documentKey}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
documentKeyyolstringEvet"örnek"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

İstek gövdesi (zorunlu)

Şema: PutSiteSearchDocumentDto

AlanTürZorunluAçıklama
urlstringEvetUzunluk: 0–2000
titlestringHayırUzunluk: 0–300
contentstringHayırUzunluk: 0–300000
htmlstringHayırUzunluk: 0–900000
languagestringHayır

Örnek:

{
  "url": "https://pushizo.com/orders/1001",
  "title": "Siparişiniz yola çıktı",
  "content": "Takip bağlantısı içeride",
  "html": "örnek",
  "language": "tr"
}

Yanıtlar

200 — Başarılı.

Şema: SiteSearchDocumentResult

AlanTürZorunluAçıklama
outcomeenumEvetDeğerler: "created", "updated", "unchanged"
documentobjectEvet
document.idstringEvet
document.keystringEvet
document.source_idstring | nullEvet
document.urlstringEvet
document.titlestringEvet
document.languagestring | nullEvet
document.chunksintegerEvet
document.charsintegerEvet
document.indexed_atstringEvet
document.created_atstringEvet

Örnek yanıt:

{
  "outcome": "created",
  "document": {
    "url": "https://pushizo.com/orders/1001",
    "id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "key": "key-2026-10",
    "source_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "title": "Siparişiniz yola çıktı",
    "language": "tr",
    "chunks": 1,
    "chars": 1,
    "indexed_at": "örnek",
    "created_at": "örnek"
  }
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/documents/örnek" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://pushizo.com/orders/1001",
  "title": "Siparişiniz yola çıktı",
  "content": "Takip bağlantısı içeride",
  "html": "örnek",
  "language": "tr"
}'

Belgeyi dizinden sil (belge kimliği veya anahtarı)

DELETE/v1/apps/{appId}/site-search/documents/{documentKey}Dene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
documentKeyyolstringEvet"örnek"
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: Ok

AlanTürZorunluAçıklama
oktrueEvet

Örnek yanıt:

{
  "ok": true
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/documents/örnek" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Arama raporu

GET/v1/apps/{appId}/site-search/reportDene (etkileşimli API belgesi, yeni sekme)

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
dayssorguintegerHayırAralık: 1–3651
appIdyolstringEvet"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Yanıtlar

200 — Başarılı.

Şema: SiteSearchReport

AlanTürZorunluAçıklama
period_daysintegerEvet
searchesintegerEvet
zero_resultsintegerEvet
click_through_ratenumberEvet
answers_requestedintegerEvet
answeredintegerEvet
not_foundintegerEvet
answer_fallbacksintegerEvet
tokensintegerEvet
top_queriesarray<object>Evet
top_queries[].querystringEvet
top_queries[].searchesintegerEvet
top_queries[].clicksintegerEvet
top_queries[].avg_resultsnumberEvet
zero_result_queriesarray<object>Evet
zero_result_queries[].querystringEvet
zero_result_queries[].searchesintegerEvet
dailyarray<object>Evet
daily[].datestringEvet
daily[].searchesintegerEvet
daily[].zero_resultsintegerEvet
daily[].answeredintegerEvet

Örnek yanıt:

{
  "period_days": 1,
  "searches": 1,
  "zero_results": 1,
  "click_through_rate": 1.5,
  "answers_requested": 1,
  "answered": 1,
  "not_found": 1,
  "answer_fallbacks": 1,
  "tokens": 1,
  "top_queries": [
    {
      "query": "ayse",
      "searches": 1,
      "clicks": 1,
      "avg_results": 1.5
    }
  ],
  "zero_result_queries": [
    {
      "query": "ayse",
      "searches": 1
    }
  ],
  "daily": [
    {
      "date": "örnek",
      "searches": 1,
      "zero_results": 1,
      "answered": 1
    }
  ]
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/report" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Bu sayfada