Оформление

Управление моделируемыми конверсиями

Моделируемая конверсия помогает оптимизировать рекламу и сайт по выбранным целям проекта. API позволяет программно создавать и обновлять такие конверсии.

База: https://api.sales-ninja.me/public/api/v1/manage/modeled-conversions

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

Тело ​

json
{
  "title": "Вероятность покупки",
  "kind": "Regular",
  "state": "Working",
  "optimizationMetric": "ConversionCount",
  "conversionFunnelId": null,
  "predictionCountStrategy": "Balanced",
  "predictionCountStrategyCustomPredictionRate": 0,
  "skipLastEventConversionTrackingForChain": false,
  "mlModelAtributionType": "AllConversions",
  "mlModelConversionPerSessionAttributionType": "OnlySessionWithConversion",
  "forecastingWindowInDays": 30,
  "sourceType": "Session",
  "useBroadTargeting": false,
  "useBroadTargetingBroadRatio": null,
  "goals": [
    {
      "goalId": "299837db-9b51-45a4-996b-844d3fd05bbd",
      "isMain": true,
      "relationType": "Optimization",
      "contributionPower": 1.0
    }
  ],
  "integrations": [],
  "externalData": null
}

Поля ​

ПолеОписание
titleНазвание в кабинете.
kindRegular, UniversalSharedPrediction или ExternalData.
stateWorking / Active / Stopped / Paused / Archived.
optimizationMetricConversionCount, Revenue, NetProfit, LtvRevenue, LtvNetProfit.
conversionFunnelIdИдентификатор воронки проекта. Если задан, цели берутся из её этапов, а goals игнорируется. null — задать цели напрямую. При выбранной воронке допустимы только ConversionCount, Revenue и NetProfit.
predictionCountStrategyУстарело. Поле принимается ради совместимости и игнорируется.
mlModelAtributionTypeAllConversions, FirstConversionPerUser, FirstConversionPerSession, MostValuableConversionPerUser, MostValuableConversionPerSession.
mlModelConversionPerSessionAttributionTypeOnlySessionWithConversion, SessionChain, UserSegments, LeadScore, Retargeting, Brandformance, AntiBot.
sourceTypePersonalization, Session, PersonalizationHit, ModeledConversionHit, PersonalizationApiHit.
goals[]Цели проекта. relationType: "Optimization" — нужное поведение, Minus — нежелательное поведение.
integrationsМассив настроек интеграций для доставки результата, если они нужны. Без настройки не создаёт внешнюю отправку автоматически.
externalDataНастройки external-data сценария для kind: "ExternalData", иначе null.

Работой конверсии управляйте через state. Отдельного запроса на принудительный пересчёт нет. Перед PUT получите сущность через GET и сохраните остальные поля: PUT заменяет её полностью. Для изменения отдельных полей используйте PATCH — см. общие правила.

Ответ ​

json
{
  "modeledConversionId": "8f3a1e4b-…",
  "entity": {
    "id": "8f3a1e4b-…",
    "title": "Вероятность покупки"
  }
}

Доступные источники сигналов ​

goals[].goalId указывает на цели проекта, которые могут опираться на разные платформы. Полный каталог источников и их предусловий — на странице Сигналы для ML. Если хотите подключить новый источник (например, Calltouch или AppMetrica) — см. Каталог интеграций.

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