Sales Ninja — документация

# Управление аудиторными сегментами

Аудиторный сегмент — это ML-классификатор «пользователь принадлежит к группе X», который учится по выбранному набору признаков и целей. CRUD позволяет программно заводить сегменты.

База: https://api.sales-ninja.me/public/api/v1/manage/audience-segments

HTTP Что делает
GET / Список сегментов.
POST /list Список со сложным фильтром.
GET /{id} Полная сущность.
POST / Создать.
PUT /{id} Обновить.
PATCH /{id} Частично обновить root-поля.
DELETE /{id} Удалить.

# Тело

{
  "title": "Готовые купить премиум-тариф",
  "state": "Working",
  "optimizationMetric": "ConversionCount",
  "predictionCountStrategy": "Balanced",
  "forecastingWindowInDays": 30,
  "useBroadTargeting": false,
  "useBroadTargetingBroadRatio": null,
  "goals": [
    {
      "goalId": "299837db-9b51-45a4-996b-844d3fd05bbd",
      "isMain": true,
      "relationType": "Optimization",
      "contributionPower": 1.0
    }
  ],
  "integrations": []
}

# Поля

Поле Описание
title Название.
state Working / Active / Stopped / Paused / Archived.
optimizationMetric Метрика обучения: ConversionCount, Revenue, NetProfit, LtvRevenue, LtvNetProfit.
predictionCountStrategy Баланс точности и объёма предсказаний: Balanced, MoreAccuracy, MorePredictCount, CustomPredictionRate, MaxAccuracy.
forecastingWindowInDays Горизонт прогноза в днях.
goals[] Цели проекта, по которым учится сегмент. Optimization — целевое поведение, Minus — нежелательное поведение.
integrations Массив настроек интеграций, если для сегмента настроена внешняя доставка. Без настройки выгрузка наружу не создаётся автоматически.

Старт обучения и переучивание управляются автоматически — программных триггеров нет.

# Ответ

{
  "audienceSegmentId": "8f3a1e4b-…",
  "entity": {
    "id": "8f3a1e4b-…",
    "title": "Готовые купить премиум-тариф"
  }
}

# Связанные страницы

← Управление антиботами →