Для AI-агентов: markdown этой страницы — /docs/api-segments.mdиндекс документации — /llms.txt
REST: segments
Обновлено
Выберите операцию: полный контракт доступен по ссылке. Scopes: ALL; auth alternatives: OR.
describeSegmentAxes
GET /api/v1/tools/segments/axes — Describe the broadcast audience taxonomy
Scopes (ALL): ["broadcasts:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
previewSegmentReach
POST /api/v1/tools/segments/reach — Preview audience reach without sending
Scopes (ALL): ["broadcasts:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
sampleSegmentAudience
POST /api/v1/tools/segments/sample — Sample a valid audience by tenant user sequence
Scopes (ALL): ["dialogs:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
listSavedSegments
GET /api/v1/tools/segments/saved — List saved audience filters
Scopes (ALL): ["broadcasts:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
createSavedSegment
POST /api/v1/tools/segments/saved — Create a saved audience filter
Scopes (ALL): ["broadcasts:write"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
deleteSavedSegment
DELETE /api/v1/tools/segments/saved/{seqNum} — Delete an unreferenced saved filter with optimistic version
Scopes (ALL): ["broadcasts:write"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
getSavedSegment
GET /api/v1/tools/segments/saved/{seqNum} — Read a saved audience filter
Scopes (ALL): ["broadcasts:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
updateSavedSegment
PATCH /api/v1/tools/segments/saved/{seqNum} — Update a saved filter with optimistic version
Scopes (ALL): ["broadcasts:write"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].
listSegmentTargets
POST /api/v1/tools/segments/targets — List a segmentation kind’s targets
Scopes (ALL): ["broadcasts:read"]. Auth (OR): [{"hubApiKey":[]},{"hubBearer":[]}].