Документация / Как начать / Работа с MCP / Идентификаторы и страницы результатов / REST: site / getSitePageNudge Для AI-агентов: markdown этой страницы — /docs/api-op-getsitepagenudge.md · индекс документации — /llms.txt
getSitePageNudge Обновлено 15 октября 2026 г.
GET /api/v1/tools/site/pages/{seqNum}/nudge
Read the nudge setting of one site page
# Авторизация и праваScopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.
Поле Значение security.0.hubApiKey [] security.1.hubBearer [] securitySchemes.hubApiKey.in "header" securitySchemes.hubApiKey.name "X-Api-Key" securitySchemes.hubApiKey.type "apiKey" securitySchemes.hubBearer.scheme "bearer" securitySchemes.hubBearer.type "http" x-required-scopes ["site:read"]
# Параметры запросаПоле Значение 0.in "path" 0.name "seqNum" 0.required true 0.schema 0.schema
# Тело запросаПоле Значение Тело запроса null
# Ответы# ОшибкиПоле Значение 400.content.application/problem+json.schema ProblemDetails 400.description "Page seq_num is not a canonical positive int4" 400.x-error-codes ["VALIDATION_ERROR"] 401.content.application/problem+json.schema ProblemDetails 401.description "Missing, invalid, revoked or conflicting credential; surface JWT is refused" 401.x-error-codes ["INVALID_API_KEY"] 403.content.application/problem+json.schema ProblemDetails 403.description "Missing scope, prohibited publishable credential or absent active bot" 403.x-error-codes ["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","NO_ACTIVE_BOT"] 413.content.application/problem+json.schema ProblemDetails 413.description "Resource policy size or item-count limit exceeded" 413.x-error-codes ["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"] 422.content.application/problem+json.schema ProblemDetails 422.description "The page does not exist for the tenant, is not published or is hidden" 422.x-error-codes ["SITE_NUDGE_PAGE_NOT_ELIGIBLE"] 429.content.application/problem+json.schema ProblemDetails 429.description "Resource rate budget exceeded or unavailable" 429.headers.Retry-After.description "Retry delay in seconds, when supplied by the limiter" 429.headers.Retry-After.schema 429.headers.Retry-After.schema 429.x-error-codes ["RATE_LIMIT_EXCEEDED","RATE_LIMIT_UNAVAILABLE"] 500.content.application/problem+json.schema ProblemDetails 500.description "Unexpected internal failure" 500.x-error-codes ["INTERNAL_ERROR"]
# Дополнительные условияПоле Значение description "site:read. The page nudge of one published, visible page of the tenant (seqNum from GET /tools/site/pages): after a visitor opened the page in a mini app and did not reach a goal for delayMinutes, the business sends them its chain step (stepSeq), then the AI Manager task (aiEnabled, aiPrompt). goalLinkCodes are the dl_ links whose tap counts as a goal; any form submission and any order, event registration or booking by the person also count. A page with no setting reads as disabled defaults. aiAvailable false means the plan has no AI Manager. Pages of the platform storefront cannot carry a nudge." operationId "getSitePageNudge" summary "Read the nudge setting of one site page" tags ["site"] x-idempotency.conflictStatus null x-idempotency.implementation "none" x-idempotency.replayStatus null x-idempotency.required false x-idempotency.scope [] x-idempotency.ttlSeconds null x-pagination.queryParameters [] x-pagination.supported false x-scope-semantics "ALL"