PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/site-searchSite search settings, index status and AI usage
PATCH/v1/apps/{appId}/site-search/settingsUpdate site search settings
GET/v1/apps/{appId}/site-search/sourcesSearch sources
POST/v1/apps/{appId}/site-search/sourcesAdd 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}/crawlRe-crawl the source now
GET/v1/apps/{appId}/site-search/documentsIndexed 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/reportSearch report

Details

GET/v1/apps/{appId}/site-searchTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SiteSearchOverview

FieldTypeRequiredDescription
settingsobjectYes
settings.enabledbooleanYes
settings.ai_answersbooleanYes
settings.allowed_originsarray<string>Yes
settings.languagestringYes
settings.text_search_configstringYes
settings.monthly_token_capintegerYes
settings.query_retention_daysintegerYes
settings.updated_atstring | nullYes
indexobjectYes
index.documentsintegerYes
index.chunksintegerYes
index.sourcesintegerYes
index.last_indexed_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.monthly_token_capintegerYes
usage.period_startstringYes
aiobjectYes
ai.availablebooleanYes
ai.reasonenum | nullYes

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

PATCH/v1/apps/{appId}/site-search/settingsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateSiteSearchSettingsDto

FieldTypeRequiredDescription
enabledbooleanNo
ai_answersbooleanNo
allowed_originsarray<string>NoItems: 0–20
languagestringNo
monthly_token_capintegerNoRange: 1000–50000000
query_retention_daysintegerNoRange: 7–365

Example:

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

Responses

200 — Success.

Schema: SiteSearchOverview

FieldTypeRequiredDescription
settingsobjectYes
settings.enabledbooleanYes
settings.ai_answersbooleanYes
settings.allowed_originsarray<string>Yes
settings.languagestringYes
settings.text_search_configstringYes
settings.monthly_token_capintegerYes
settings.query_retention_daysintegerYes
settings.updated_atstring | nullYes
indexobjectYes
index.documentsintegerYes
index.chunksintegerYes
index.sourcesintegerYes
index.last_indexed_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.monthly_token_capintegerYes
usage.period_startstringYes
aiobjectYes
ai.availablebooleanYes
ai.reasonenum | nullYes

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

GET/v1/apps/{appId}/site-search/sourcesTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SiteSearchSourceList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].kindenumYesValues: "sitemap", "urls"
data[].urlstring | nullYes
data[].urlsarray<string>Yes
data[].max_pagesintegerYes
data[].refresh_hoursinteger | nullYes
data[].enabledbooleanYes
data[].statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
data[].documentsintegerYes
data[].crawl_requested_atstring | nullYes
data[].last_crawled_atstring | nullYes
data[].next_crawl_atstring | nullYes
data[].last_errorstring | nullYes
data[].statsobjectYes
data[].stats.pages_foundintegerYes
data[].stats.pages_indexedintegerYes
data[].stats.pages_unchangedintegerYes
data[].stats.pages_skippedintegerYes
data[].stats.pages_failedintegerYes
data[].stats.pages_removedintegerYes
data[].stats.duration_msintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/site-search/sourcesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateSiteSearchSourceDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
kindenumYesValues: "sitemap", "urls"
urlstringNoLength: 0–2000
urlsarray<string>NoItems: 1–500
max_pagesintegerNoRange: 1–2000
refresh_hoursinteger | nullNo
enabledbooleanNo

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

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "sitemap", "urls"
urlstring | nullYes
urlsarray<string>Yes
max_pagesintegerYes
refresh_hoursinteger | nullYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
documentsintegerYes
crawl_requested_atstring | nullYes
last_crawled_atstring | nullYes
next_crawl_atstring | nullYes
last_errorstring | nullYes
statsobjectYes
stats.pages_foundintegerYes
stats.pages_indexedintegerYes
stats.pages_unchangedintegerYes
stats.pages_skippedintegerYes
stats.pages_failedintegerYes
stats.pages_removedintegerYes
stats.duration_msintegerYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/site-search/sources/{sourceId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateSiteSearchSourceDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
kindenumNoValues: "sitemap", "urls"
urlstringNoLength: 0–2000
urlsarray<string>NoItems: 1–500
max_pagesintegerNoRange: 1–2000
refresh_hoursinteger | nullNo
enabledbooleanNo

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

FieldTypeRequiredDescription
idstringYes
namestringYes
kindenumYesValues: "sitemap", "urls"
urlstring | nullYes
urlsarray<string>Yes
max_pagesintegerYes
refresh_hoursinteger | nullYes
enabledbooleanYes
statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
documentsintegerYes
crawl_requested_atstring | nullYes
last_crawled_atstring | nullYes
next_crawl_atstring | nullYes
last_errorstring | nullYes
statsobjectYes
stats.pages_foundintegerYes
stats.pages_indexedintegerYes
stats.pages_unchangedintegerYes
stats.pages_skippedintegerYes
stats.pages_failedintegerYes
stats.pages_removedintegerYes
stats.duration_msintegerYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/site-search/sources/{sourceId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

POST/v1/apps/{appId}/site-search/sources/{sourceId}/crawlTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
sourceIdpathstringYes"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SiteSearchCrawlRequest

FieldTypeRequiredDescription
queuedbooleanYes
sourceobjectYes
source.idstringYes
source.namestringYes
source.kindenumYesValues: "sitemap", "urls"
source.urlstring | nullYes
source.urlsarray<string>Yes
source.max_pagesintegerYes
source.refresh_hoursinteger | nullYes
source.enabledbooleanYes
source.statusenumYesValues: "idle", "queued", "crawling", "ok", "partial", "failed"
source.documentsintegerYes
source.crawl_requested_atstring | nullYes
source.last_crawled_atstring | nullYes
source.next_crawl_atstring | nullYes
source.last_errorstring | nullYes
source.statsobjectYes
source.stats.pages_foundintegerYes
source.stats.pages_indexedintegerYes
source.stats.pages_unchangedintegerYes
source.stats.pages_skippedintegerYes
source.stats.pages_failedintegerYes
source.stats.pages_removedintegerYes
source.stats.duration_msintegerYes
source.created_atstringYes
source.updated_atstringYes

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

GET/v1/apps/{appId}/site-search/documentsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
source_idquerystringNoLength: 0–60"id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
qquerystringNoLength: 0–200"ayse"
limitqueryintegerNoRange: 1–10050
cursorquerystringNo"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SiteSearchDocumentPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].keystringYes
data[].source_idstring | nullYes
data[].urlstringYes
data[].titlestringYes
data[].languagestring | nullYes
data[].chunksintegerYes
data[].charsintegerYes
data[].indexed_atstringYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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)

PUT/v1/apps/{appId}/site-search/documents/{documentKey}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
documentKeypathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PutSiteSearchDocumentDto

FieldTypeRequiredDescription
urlstringYesLength: 0–2000
titlestringNoLength: 0–300
contentstringNoLength: 0–300000
htmlstringNoLength: 0–900000
languagestringNo

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

FieldTypeRequiredDescription
outcomeenumYesValues: "created", "updated", "unchanged"
documentobjectYes
document.idstringYes
document.keystringYes
document.source_idstring | nullYes
document.urlstringYes
document.titlestringYes
document.languagestring | nullYes
document.chunksintegerYes
document.charsintegerYes
document.indexed_atstringYes
document.created_atstringYes

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)

DELETE/v1/apps/{appId}/site-search/documents/{documentKey}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
documentKeypathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/site-search/reportTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
daysqueryintegerNoRange: 1–3651
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SiteSearchReport

FieldTypeRequiredDescription
period_daysintegerYes
searchesintegerYes
zero_resultsintegerYes
click_through_ratenumberYes
answers_requestedintegerYes
answeredintegerYes
not_foundintegerYes
answer_fallbacksintegerYes
tokensintegerYes
top_queriesarray<object>Yes
top_queries[].querystringYes
top_queries[].searchesintegerYes
top_queries[].clicksintegerYes
top_queries[].avg_resultsnumberYes
zero_result_queriesarray<object>Yes
zero_result_queries[].querystringYes
zero_result_queries[].searchesintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].searchesintegerYes
daily[].zero_resultsintegerYes
daily[].answeredintegerYes

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"

On this page