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öntem | Yol | İşlem |
|---|---|---|
GET | /v1/apps/{appId}/site-search | Site araması ayarları, dizin durumu ve AI kullanımı |
PATCH | /v1/apps/{appId}/site-search/settings | Site araması ayarlarını güncelle |
GET | /v1/apps/{appId}/site-search/sources | Arama kaynakları |
POST | /v1/apps/{appId}/site-search/sources | Arama 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}/crawl | Kaynağı şimdi yeniden tara |
GET | /v1/apps/{appId}/site-search/documents | Dizindeki 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/report | Arama raporu |
Ayrıntılar
Site araması ayarları, dizin durumu ve AI kullanımı
Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SiteSearchOverview
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
settings | object | Evet | |
settings.enabled | boolean | Evet | |
settings.ai_answers | boolean | Evet | |
settings.allowed_origins | array<string> | Evet | |
settings.language | string | Evet | |
settings.text_search_config | string | Evet | |
settings.monthly_token_cap | integer | Evet | |
settings.query_retention_days | integer | Evet | |
settings.updated_at | string | null | Evet | |
index | object | Evet | |
index.documents | integer | Evet | |
index.chunks | integer | Evet | |
index.sources | integer | Evet | |
index.last_indexed_at | string | null | Evet | |
usage | object | Evet | |
usage.tokens_this_month | integer | Evet | |
usage.monthly_token_cap | integer | Evet | |
usage.period_start | string | Evet | |
ai | object | Evet | |
ai.available | boolean | Evet | |
ai.reason | enum | null | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: UpdateSiteSearchSettingsDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
enabled | boolean | Hayır | |
ai_answers | boolean | Hayır | |
allowed_origins | array<string> | Hayır | Öğe: 0–20 |
language | string | Hayır | |
monthly_token_cap | integer | Hayır | Aralık: 1000–50000000 |
query_retention_days | integer | Hayır | Aralı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
settings | object | Evet | |
settings.enabled | boolean | Evet | |
settings.ai_answers | boolean | Evet | |
settings.allowed_origins | array<string> | Evet | |
settings.language | string | Evet | |
settings.text_search_config | string | Evet | |
settings.monthly_token_cap | integer | Evet | |
settings.query_retention_days | integer | Evet | |
settings.updated_at | string | null | Evet | |
index | object | Evet | |
index.documents | integer | Evet | |
index.chunks | integer | Evet | |
index.sources | integer | Evet | |
index.last_indexed_at | string | null | Evet | |
usage | object | Evet | |
usage.tokens_this_month | integer | Evet | |
usage.monthly_token_cap | integer | Evet | |
usage.period_start | string | Evet | |
ai | object | Evet | |
ai.available | boolean | Evet | |
ai.reason | enum | null | Evet |
Ö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ı
Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SiteSearchSourceList
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].name | string | Evet | |
data[].kind | enum | Evet | Değerler: "sitemap", "urls" |
data[].url | string | null | Evet | |
data[].urls | array<string> | Evet | |
data[].max_pages | integer | Evet | |
data[].refresh_hours | integer | null | Evet | |
data[].enabled | boolean | Evet | |
data[].status | enum | Evet | Değerler: "idle", "queued", "crawling", "ok", "partial", "failed" |
data[].documents | integer | Evet | |
data[].crawl_requested_at | string | null | Evet | |
data[].last_crawled_at | string | null | Evet | |
data[].next_crawl_at | string | null | Evet | |
data[].last_error | string | null | Evet | |
data[].stats | object | Evet | |
data[].stats.pages_found | integer | Evet | |
data[].stats.pages_indexed | integer | Evet | |
data[].stats.pages_unchanged | integer | Evet | |
data[].stats.pages_skipped | integer | Evet | |
data[].stats.pages_failed | integer | Evet | |
data[].stats.pages_removed | integer | Evet | |
data[].stats.duration_ms | integer | Evet | |
data[].created_at | string | Evet | |
data[].updated_at | string | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: CreateSiteSearchSourceDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Evet | Uzunluk: 1–80 |
kind | enum | Evet | Değerler: "sitemap", "urls" |
url | string | Hayır | Uzunluk: 0–2000 |
urls | array<string> | Hayır | Öğe: 1–500 |
max_pages | integer | Hayır | Aralık: 1–2000 |
refresh_hours | integer | null | Hayır | |
enabled | boolean | Hayı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "sitemap", "urls" |
url | string | null | Evet | |
urls | array<string> | Evet | |
max_pages | integer | Evet | |
refresh_hours | integer | null | Evet | |
enabled | boolean | Evet | |
status | enum | Evet | Değerler: "idle", "queued", "crawling", "ok", "partial", "failed" |
documents | integer | Evet | |
crawl_requested_at | string | null | Evet | |
last_crawled_at | string | null | Evet | |
next_crawl_at | string | null | Evet | |
last_error | string | null | Evet | |
stats | object | Evet | |
stats.pages_found | integer | Evet | |
stats.pages_indexed | integer | Evet | |
stats.pages_unchanged | integer | Evet | |
stats.pages_skipped | integer | Evet | |
stats.pages_failed | integer | Evet | |
stats.pages_removed | integer | Evet | |
stats.duration_ms | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
sourceId | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: UpdateSiteSearchSourceDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | Hayır | Uzunluk: 1–80 |
kind | enum | Hayır | Değerler: "sitemap", "urls" |
url | string | Hayır | Uzunluk: 0–2000 |
urls | array<string> | Hayır | Öğe: 1–500 |
max_pages | integer | Hayır | Aralık: 1–2000 |
refresh_hours | integer | null | Hayır | |
enabled | boolean | Hayı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
name | string | Evet | |
kind | enum | Evet | Değerler: "sitemap", "urls" |
url | string | null | Evet | |
urls | array<string> | Evet | |
max_pages | integer | Evet | |
refresh_hours | integer | null | Evet | |
enabled | boolean | Evet | |
status | enum | Evet | Değerler: "idle", "queued", "crawling", "ok", "partial", "failed" |
documents | integer | Evet | |
crawl_requested_at | string | null | Evet | |
last_crawled_at | string | null | Evet | |
next_crawl_at | string | null | Evet | |
last_error | string | null | Evet | |
stats | object | Evet | |
stats.pages_found | integer | Evet | |
stats.pages_indexed | integer | Evet | |
stats.pages_unchanged | integer | Evet | |
stats.pages_skipped | integer | Evet | |
stats.pages_failed | integer | Evet | |
stats.pages_removed | integer | Evet | |
stats.duration_ms | integer | Evet | |
created_at | string | Evet | |
updated_at | string | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
sourceId | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: Ok
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | true | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
sourceId | yol | string | Evet | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SiteSearchCrawlRequest
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
queued | boolean | Evet | |
source | object | Evet | |
source.id | string | Evet | |
source.name | string | Evet | |
source.kind | enum | Evet | Değerler: "sitemap", "urls" |
source.url | string | null | Evet | |
source.urls | array<string> | Evet | |
source.max_pages | integer | Evet | |
source.refresh_hours | integer | null | Evet | |
source.enabled | boolean | Evet | |
source.status | enum | Evet | Değerler: "idle", "queued", "crawling", "ok", "partial", "failed" |
source.documents | integer | Evet | |
source.crawl_requested_at | string | null | Evet | |
source.last_crawled_at | string | null | Evet | |
source.next_crawl_at | string | null | Evet | |
source.last_error | string | null | Evet | |
source.stats | object | Evet | |
source.stats.pages_found | integer | Evet | |
source.stats.pages_indexed | integer | Evet | |
source.stats.pages_unchanged | integer | Evet | |
source.stats.pages_skipped | integer | Evet | |
source.stats.pages_failed | integer | Evet | |
source.stats.pages_removed | integer | Evet | |
source.stats.duration_ms | integer | Evet | |
source.created_at | string | Evet | |
source.updated_at | string | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
source_id | sorgu | string | Hayır | Uzunluk: 0–60 | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
q | sorgu | string | Hayır | Uzunluk: 0–200 | "ayse" |
limit | sorgu | integer | Hayır | Aralık: 1–100 | 50 |
cursor | sorgu | string | Hayır | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SiteSearchDocumentPage
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
data | array<object> | Evet | |
data[].id | string | Evet | |
data[].key | string | Evet | |
data[].source_id | string | null | Evet | |
data[].url | string | Evet | |
data[].title | string | Evet | |
data[].language | string | null | Evet | |
data[].chunks | integer | Evet | |
data[].chars | integer | Evet | |
data[].indexed_at | string | Evet | |
data[].created_at | string | Evet | |
next_cursor | string | null | Evet | |
has_more | boolean | Evet |
Ö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)
Kimlik doğrulama: API anahtarı — kapsam admin (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
documentKey | yol | string | Evet | "örnek" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: PutSiteSearchDocumentDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
url | string | Evet | Uzunluk: 0–2000 |
title | string | Hayır | Uzunluk: 0–300 |
content | string | Hayır | Uzunluk: 0–300000 |
html | string | Hayır | Uzunluk: 0–900000 |
language | string | Hayı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
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
outcome | enum | Evet | Değerler: "created", "updated", "unchanged" |
document | object | Evet | |
document.id | string | Evet | |
document.key | string | Evet | |
document.source_id | string | null | Evet | |
document.url | string | Evet | |
document.title | string | Evet | |
document.language | string | null | Evet | |
document.chunks | integer | Evet | |
document.chars | integer | Evet | |
document.indexed_at | string | Evet | |
document.created_at | string | Evet |
Ö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ı)
/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
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
documentKey | yol | string | Evet | "örnek" | |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: Ok
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
ok | true | Evet |
Ö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
Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
days | sorgu | integer | Hayır | Aralık: 1–365 | 1 |
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Yanıtlar
200 — Başarılı.
Şema: SiteSearchReport
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
period_days | integer | Evet | |
searches | integer | Evet | |
zero_results | integer | Evet | |
click_through_rate | number | Evet | |
answers_requested | integer | Evet | |
answered | integer | Evet | |
not_found | integer | Evet | |
answer_fallbacks | integer | Evet | |
tokens | integer | Evet | |
top_queries | array<object> | Evet | |
top_queries[].query | string | Evet | |
top_queries[].searches | integer | Evet | |
top_queries[].clicks | integer | Evet | |
top_queries[].avg_results | number | Evet | |
zero_result_queries | array<object> | Evet | |
zero_result_queries[].query | string | Evet | |
zero_result_queries[].searches | integer | Evet | |
daily | array<object> | Evet | |
daily[].date | string | Evet | |
daily[].searches | integer | Evet | |
daily[].zero_results | integer | Evet | |
daily[].answered | integer | Evet |
Ö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"