Для AI-агентов: markdown этой страницы — /docs/api-op-describesegmentaxes.md · индекс документации — /llms.txt
describeSegmentAxes
Обновлено
GET /api/v1/tools/segments/axes
Describe the broadcast audience taxonomy
#Авторизация и права
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"] |
#Параметры запроса
#Тело запроса
| Поле | Значение |
|---|
| Тело запроса | null |
#Ответы
#Ошибки
| Поле | Значение |
|---|
| 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"] |
| 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"] |
| 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 | "Read-only category/axis taxonomy. Entity targets use tenant sequence strings and display titles." |
| operationId | "describeSegmentAxes" |
| summary | "Describe the broadcast audience taxonomy" |
| tags | ["segments"] |
| x-idempotency.kind | "none" |
| x-pagination.kind | "none" |