К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-getsitepagenudgestats.mdиндекс документации — /llms.txt

getSitePageNudgeStats

Обновлено

GET /api/v1/tools/site/pages/{seqNum}/nudge/stats

Read the nudge funnel 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.requiredtrue
0.schema0.schema
1.in"query"
1.name"from"
1.requiredfalse
1.schema1.schema
2.in"query"
2.name"to"
2.requiredfalse
2.schema2.schema

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaSiteNudgeStats
200.description"Tenant site control-plane result"
200.headers.X-Bot-Username.description"Active bot username, when resolved"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant slug, when resolved"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining request budget"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Unix window reset in seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Page seq_num is not a canonical positive int4, or from/to is not an ISO-8601 instant"
400.x-error-codes["VALIDATION_ERROR"]
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked or conflicting credential; surface JWT is refused"
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
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.schemaProblemDetails
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.schemaProblemDetails
422.description"Only a seqNum that matches no page of the tenant is refused (an unpublished or hidden page is still read); or the window is empty (from is not before to)"
422.x-error-codes["SITE_NUDGE_PAGE_NOT_ELIGIBLE","INVALID_INPUT"]
429.content.application/problem+json.schemaProblemDetails
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.schema429.headers.Retry-After.schema
429.x-error-codes["RATE_LIMIT_EXCEEDED","RATE_LIMIT_UNAVAILABLE"]
500.content.application/problem+json.schemaProblemDetails
500.description"Unexpected internal failure"
500.x-error-codes["INTERNAL_ERROR"]

Дополнительные условия

ПолеЗначение
description"site:read. The funnel over the half-open window [from, to) (ISO-8601 instants; default the last 30 days ending now): visits (mini-app opens of the page), cooldownVisits (opens inside the 30-day cooldown), waits started, pending (still waiting), goalBeforeFire (reached a goal before the timer, no nudge sent), fired, goalAfterFire (fired waits whose person reached a goal afterwards), superseded (replaced by a wait on another page, or cancelled because the nudge was turned off or the page hidden or unpublished), failed (the timer fired and the channel refused), plus stepOutcomes and aiOutcomes of waits whose timer fired (fired or failed; superseded excluded). A page that is unpublished or hidden can still be read."
operationId"getSitePageNudgeStats"
summary"Read the nudge funnel of one site page"
tags["site"]
x-idempotency.conflictStatusnull
x-idempotency.implementation"none"
x-idempotency.replayStatusnull
x-idempotency.requiredfalse
x-idempotency.scope[]
x-idempotency.ttlSecondsnull
x-pagination.queryParameters[]
x-pagination.supportedfalse
x-scope-semantics"ALL"