Оформление
Управление конверсионными воронками
Методы работают с проектом, к которому относится X-SN-TOKEN. Сначала прочитайте каталог целей, чтобы найти цели для конверсионной воронки.
Чтение, сохранение и удаление воронок
Базовый путь — /public/api/v1/manage/conversion-funnels. Передавайте UUID воронки в {funnelId}.
| Запрос | Тело | Успешный ответ |
|---|---|---|
GET / | Без тела | 200 OK, {"items":[]} для пустого списка. Каждый элемент имеет тот же формат, что отдельная воронка. |
GET /{funnelId} | Без тела | 200 OK, объект воронки как entity ниже. |
POST / | Название и все этапы. | 200 OK, conversionFunnelId и entity. |
PUT /{funnelId} | Целиком воронка, включая неизменённые этапы. | 200 OK, conversionFunnelId и entity. |
DELETE /{funnelId} | Без тела | 204 No Content |
Пример создания воронки из двух этапов
Например, для учёта заявок и подтверждённых продаж вымышленного магазина передайте такое тело в POST. Замените UUID на цели вашего проекта.
json
{
"title": "Demo customer journey",
"stages": [
{
"title": "Lead received",
"goals": [
{
"goalId": "28216cb8-901e-417b-a861-781b756feb2c",
"relationType": "optimization"
}
]
},
{
"title": "Sale confirmed",
"goals": [
{
"goalId": "803b2059-11d2-43ba-ad21-2e2e0ad62665",
"relationType": "optimization",
"value": 1000
}
]
}
]
}| Поле | Что задаёт |
|---|---|
title | Название воронки. У каждого этапа есть своё название. |
stages | Полный список этапов по порядку. В PUT оставляйте возвращённые ID существующих этапов. У нового этапа пропустите ID. |
goals[].goalId | UUID измеряемой цели в этом проекте. |
goals[].relationType | optimization для целевого результата или minus для минус-цели. По умолчанию используется optimization. |
goals[].value | Заданная ценность оптимизационной цели в рублях, когда она нужна. |
Например, ответ на сохранение до появления рассчитанных значений:
json
{
"conversionFunnelId": "097ad81e-97cf-47f3-8065-6acde3183156",
"entity": {
"id": "097ad81e-97cf-47f3-8065-6acde3183156",
"title": "Demo customer journey",
"createdOnUtc": "2026-01-15T10:00:00Z",
"updatedOnUtc": "2026-01-15T10:00:00Z",
"stages": [
{
"id": "e8fc3ccb-64b0-49f4-b5e6-3c5b0281a457",
"title": "Lead received",
"goals": [
{
"goalId": "28216cb8-901e-417b-a861-781b756feb2c",
"relationType": "optimization"
}
]
},
{
"id": "6b3959f7-20d3-4709-9f1a-d89c747cfd24",
"title": "Sale confirmed",
"goals": [
{
"goalId": "803b2059-11d2-43ba-ad21-2e2e0ad62665",
"relationType": "optimization",
"value": 1000
}
]
}
],
"usedBy": []
}
}Как проверить изменения и исправить ошибки
Перед обновлением прочитайте воронку и сохраните этапы, которые хотите оставить. Сравните возвращённую entity с нужным порядком этапов и ID целей. Поля ценности и доли достижения могут отсутствовать, пока они не рассчитаны.
Перед удалением проверьте usedBy у воронки. Если она используется, API отклонит удаление. Если GET вернул 404, проверьте UUID воронки и проект. При ошибке сохранения проверьте поле и код из ответа API управления.