Site search
Site search — 11 operations (GET /v1/apps/{appId}/site-search, PATCH /v1/apps/{appId}/site-search/settings, GET /v1/apps/{appId}/site-search/sources, …). Generated from the OpenAPI 3.1.0 contract.
Search embedded in a website: the content index (crawled or uploaded through the API), sources and crawl status, settings (AI answers, origin list, monthly token cap) and the query report. Visitor searches go through the keyless SDK endpoint used by the Web SDK. Requires the Growth+ plan.
Base URL: https://api.pushizo.com · Tag: site-search · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/site-search | Site search settings, index status and AI usage |
PATCH | /v1/apps/{appId}/site-search/settings | Update site search settings |
GET | /v1/apps/{appId}/site-search/sources | Search sources |
POST | /v1/apps/{appId}/site-search/sources | Add a search source |
PATCH | /v1/apps/{appId}/site-search/sources/{sourceId} | Edit a search source |
DELETE | /v1/apps/{appId}/site-search/sources/{sourceId} | Delete a search source and its pages |
POST | /v1/apps/{appId}/site-search/sources/{sourceId}/crawl | Re-crawl the source now |
GET | /v1/apps/{appId}/site-search/documents | Indexed documents |
PUT | /v1/apps/{appId}/site-search/documents/{documentKey} | Upload or replace a document in the index (the key is unique within the app) |
DELETE | /v1/apps/{appId}/site-search/documents/{documentKey} | Delete a document from the index (document ID or key) |
GET | /v1/apps/{appId}/site-search/report | Search report |
Details
Site search settings, index status and AI usage
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SiteSearchOverview
| Field | Type | Required | Description |
|---|---|---|---|
settings | object | Yes | |
settings.enabled | boolean | Yes | |
settings.ai_answers | boolean | Yes | |
settings.allowed_origins | array<string> | Yes | |
settings.language | string | Yes | |
settings.text_search_config | string | Yes | |
settings.monthly_token_cap | integer | Yes | |
settings.query_retention_days | integer | Yes | |
settings.updated_at | string | null | Yes | |
index | object | Yes | |
index.documents | integer | Yes | |
index.chunks | integer | Yes | |
index.sources | integer | Yes | |
index.last_indexed_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.monthly_token_cap | integer | Yes | |
usage.period_start | string | Yes | |
ai | object | Yes | |
ai.available | boolean | Yes | |
ai.reason | enum | null | Yes |
Example response:
{
"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"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update site search settings
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateSiteSearchSettingsDto
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | No | |
ai_answers | boolean | No | |
allowed_origins | array<string> | No | Items: 0–20 |
language | string | No | |
monthly_token_cap | integer | No | Range: 1000–50000000 |
query_retention_days | integer | No | Range: 7–365 |
Example:
{
"enabled": true,
"ai_answers": true,
"allowed_origins": [
"örnek"
],
"language": "tr",
"monthly_token_cap": 1000
}Responses
200 — Success.
Schema: SiteSearchOverview
| Field | Type | Required | Description |
|---|---|---|---|
settings | object | Yes | |
settings.enabled | boolean | Yes | |
settings.ai_answers | boolean | Yes | |
settings.allowed_origins | array<string> | Yes | |
settings.language | string | Yes | |
settings.text_search_config | string | Yes | |
settings.monthly_token_cap | integer | Yes | |
settings.query_retention_days | integer | Yes | |
settings.updated_at | string | null | Yes | |
index | object | Yes | |
index.documents | integer | Yes | |
index.chunks | integer | Yes | |
index.sources | integer | Yes | |
index.last_indexed_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.monthly_token_cap | integer | Yes | |
usage.period_start | string | Yes | |
ai | object | Yes | |
ai.available | boolean | Yes | |
ai.reason | enum | null | Yes |
Example response:
{
"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"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
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
}'Search sources
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SiteSearchSourceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].kind | enum | Yes | Values: "sitemap", "urls" |
data[].url | string | null | Yes | |
data[].urls | array<string> | Yes | |
data[].max_pages | integer | Yes | |
data[].refresh_hours | integer | null | Yes | |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
data[].documents | integer | Yes | |
data[].crawl_requested_at | string | null | Yes | |
data[].last_crawled_at | string | null | Yes | |
data[].next_crawl_at | string | null | Yes | |
data[].last_error | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.pages_found | integer | Yes | |
data[].stats.pages_indexed | integer | Yes | |
data[].stats.pages_unchanged | integer | Yes | |
data[].stats.pages_skipped | integer | Yes | |
data[].stats.pages_failed | integer | Yes | |
data[].stats.pages_removed | integer | Yes | |
data[].stats.duration_ms | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"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"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add a search source
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateSiteSearchSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
kind | enum | Yes | Values: "sitemap", "urls" |
url | string | No | Length: 0–2000 |
urls | array<string> | No | Items: 1–500 |
max_pages | integer | No | Range: 1–2000 |
refresh_hours | integer | null | No | |
enabled | boolean | No |
Example:
{
"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
}Responses
201 — Success.
Schema: SiteSearchSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "sitemap", "urls" |
url | string | null | Yes | |
urls | array<string> | Yes | |
max_pages | integer | Yes | |
refresh_hours | integer | null | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
documents | integer | Yes | |
crawl_requested_at | string | null | Yes | |
last_crawled_at | string | null | Yes | |
next_crawl_at | string | null | Yes | |
last_error | string | null | Yes | |
stats | object | Yes | |
stats.pages_found | integer | Yes | |
stats.pages_indexed | integer | Yes | |
stats.pages_unchanged | integer | Yes | |
stats.pages_skipped | integer | Yes | |
stats.pages_failed | integer | Yes | |
stats.pages_removed | integer | Yes | |
stats.duration_ms | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"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"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
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
}'Edit a search source
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateSiteSearchSourceDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
kind | enum | No | Values: "sitemap", "urls" |
url | string | No | Length: 0–2000 |
urls | array<string> | No | Items: 1–500 |
max_pages | integer | No | Range: 1–2000 |
refresh_hours | integer | null | No | |
enabled | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"enabled": true,
"kind": "sitemap",
"urls": [
"https://pushizo.com/orders/1001"
]
}Responses
200 — Success.
Schema: SiteSearchSource
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
kind | enum | Yes | Values: "sitemap", "urls" |
url | string | null | Yes | |
urls | array<string> | Yes | |
max_pages | integer | Yes | |
refresh_hours | integer | null | Yes | |
enabled | boolean | Yes | |
status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
documents | integer | Yes | |
crawl_requested_at | string | null | Yes | |
last_crawled_at | string | null | Yes | |
next_crawl_at | string | null | Yes | |
last_error | string | null | Yes | |
stats | object | Yes | |
stats.pages_found | integer | Yes | |
stats.pages_indexed | integer | Yes | |
stats.pages_unchanged | integer | Yes | |
stats.pages_skipped | integer | Yes | |
stats.pages_failed | integer | Yes | |
stats.pages_removed | integer | Yes | |
stats.duration_ms | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"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"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
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"
]
}'Delete a search source and its pages
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Re-crawl the source now
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
sourceId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SiteSearchCrawlRequest
| Field | Type | Required | Description |
|---|---|---|---|
queued | boolean | Yes | |
source | object | Yes | |
source.id | string | Yes | |
source.name | string | Yes | |
source.kind | enum | Yes | Values: "sitemap", "urls" |
source.url | string | null | Yes | |
source.urls | array<string> | Yes | |
source.max_pages | integer | Yes | |
source.refresh_hours | integer | null | Yes | |
source.enabled | boolean | Yes | |
source.status | enum | Yes | Values: "idle", "queued", "crawling", "ok", "partial", "failed" |
source.documents | integer | Yes | |
source.crawl_requested_at | string | null | Yes | |
source.last_crawled_at | string | null | Yes | |
source.next_crawl_at | string | null | Yes | |
source.last_error | string | null | Yes | |
source.stats | object | Yes | |
source.stats.pages_found | integer | Yes | |
source.stats.pages_indexed | integer | Yes | |
source.stats.pages_unchanged | integer | Yes | |
source.stats.pages_skipped | integer | Yes | |
source.stats.pages_failed | integer | Yes | |
source.stats.pages_removed | integer | Yes | |
source.stats.duration_ms | integer | Yes | |
source.created_at | string | Yes | |
source.updated_at | string | Yes |
Example response:
{
"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"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/sources/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/crawl" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Indexed documents
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
source_id | query | string | No | Length: 0–60 | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
q | query | string | No | Length: 0–200 | "ayse" |
limit | query | integer | No | Range: 1–100 | 50 |
cursor | query | string | No | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SiteSearchDocumentPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].key | string | Yes | |
data[].source_id | string | null | Yes | |
data[].url | string | Yes | |
data[].title | string | Yes | |
data[].language | string | null | Yes | |
data[].chunks | integer | Yes | |
data[].chars | integer | Yes | |
data[].indexed_at | string | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"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
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/documents?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Upload or replace a document in the index (the key is unique within the app)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
documentKey | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PutSiteSearchDocumentDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Length: 0–2000 |
title | string | No | Length: 0–300 |
content | string | No | Length: 0–300000 |
html | string | No | Length: 0–900000 |
language | string | No |
Example:
{
"url": "https://pushizo.com/orders/1001",
"title": "Siparişiniz yola çıktı",
"content": "Takip bağlantısı içeride",
"html": "örnek",
"language": "tr"
}Responses
200 — Success.
Schema: SiteSearchDocumentResult
| Field | Type | Required | Description |
|---|---|---|---|
outcome | enum | Yes | Values: "created", "updated", "unchanged" |
document | object | Yes | |
document.id | string | Yes | |
document.key | string | Yes | |
document.source_id | string | null | Yes | |
document.url | string | Yes | |
document.title | string | Yes | |
document.language | string | null | Yes | |
document.chunks | integer | Yes | |
document.chars | integer | Yes | |
document.indexed_at | string | Yes | |
document.created_at | string | Yes |
Example response:
{
"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"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
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"
}'Delete a document from the index (document ID or key)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
documentKey | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/documents/örnek" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Search report
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
days | query | integer | No | Range: 1–365 | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SiteSearchReport
| Field | Type | Required | Description |
|---|---|---|---|
period_days | integer | Yes | |
searches | integer | Yes | |
zero_results | integer | Yes | |
click_through_rate | number | Yes | |
answers_requested | integer | Yes | |
answered | integer | Yes | |
not_found | integer | Yes | |
answer_fallbacks | integer | Yes | |
tokens | integer | Yes | |
top_queries | array<object> | Yes | |
top_queries[].query | string | Yes | |
top_queries[].searches | integer | Yes | |
top_queries[].clicks | integer | Yes | |
top_queries[].avg_results | number | Yes | |
zero_result_queries | array<object> | Yes | |
zero_result_queries[].query | string | Yes | |
zero_result_queries[].searches | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].searches | integer | Yes | |
daily[].zero_results | integer | Yes | |
daily[].answered | integer | Yes |
Example response:
{
"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
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/site-search/report" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Web personalization
Web personalization — 8 operations (GET /v1/apps/{appId}/web-personalizations, POST /v1/apps/{appId}/web-personalizations, GET /v1/apps/{appId}/web-personalizations/{personalizationId}, …). Generated from the OpenAPI 3.1.0 contract.
Forms
Forms — 7 operations (GET /v1/apps/{appId}/forms, POST /v1/apps/{appId}/forms, GET /v1/apps/{appId}/forms/{formId}, …). Generated from the OpenAPI 3.1.0 contract.