Документация / Как начать / Работа с MCP / Идентификаторы и страницы результатов / REST: segments / previewSegmentReach Для AI-агентов: markdown этой страницы — /docs/api-op-previewsegmentreach.md · индекс документации — /llms.txt
previewSegmentReach Обновлено 4 октября 2026 г.
POST /api/v1/tools/segments/reach
Preview audience reach without sending
# Авторизация и права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 ["broadcasts:read"]
# Параметры запросаПоле Значение 0.description "Replay the same tenant, credential, controller handler and request for 24 hours." 0.in "header" 0.name "Idempotency-Key" 0.required true 0.schema 0.schema
# Тело запроса# Ответы# ОшибкиПоле Значение 400.content.application/problem+json.schema ProblemDetails 400.description "Strict outer request validation failed or POST body lacks Idempotency-Key." 400.x-error-codes ["VALIDATION_ERROR","IDEMPOTENCY_KEY_REQUIRED"] 401.content.application/problem+json.schema ProblemDetails 401.description "Missing, invalid, revoked, expired or conflicting API credentials; surface-session JWT is not accepted." 401.x-error-codes ["INVALID_API_KEY"] 403.content.application/problem+json.schema ProblemDetails 403.description "Required effective scope, non-publishable credential and an active bot are mandatory." 403.x-error-codes ["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","NO_ACTIVE_BOT"] 409.content.application/problem+json.schema ProblemDetails 409.description "The same-key request is already processing, or the saved segment version/reference conflicts." 409.x-error-codes ["CONFLICT"] 413.content.application/problem+json.schema ProblemDetails 413.description "The per-tool request size or item count exceeds the resource policy." 413.x-error-codes ["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"] 422.content.application/problem+json.schema ProblemDetails 422.description "Idempotency-Key was reused with different request inputs." 422.x-error-codes ["IDEMPOTENCY_KEY_MISMATCH"] 429.content.application/problem+json.schema ProblemDetails 429.description "The per-tool rate limit is exceeded or unavailable; fail closed." 429.headers.Retry-After.description "Seconds before retry, when supplied by the resource policy." 429.headers.Retry-After.required false 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 failure; the private cause is withheld." 500.x-error-codes ["INTERNAL_ERROR"]
# Дополнительные условияПоле Значение description "A loose filter object is intentional: invalid segment rules return valid:false, issues and reachable:0 rather than rejecting the preview. Optional breakdown preserves unavailable counts as null. Current REST transport retains POST 201 and requires Idempotency-Key." operationId "previewSegmentReach" summary "Preview audience reach without sending" tags ["segments"] x-idempotency.mismatchStatus 422 x-idempotency.required true x-idempotency.ttlSeconds 86400 x-pagination.kind "none"