Оформление
Чтение сведений о проекте и целей
Методы работают с проектом, к которому относится X-SN-TOKEN. Начните со сведений о проекте, чтобы проверить токен. Из каталога целей возьмите ID для отчёта, конверсионной воронки или моделируемой конверсии.
Получить сведения о проекте
GET /public/api/v1/manage/project
Параметры запроса и тело не нужны. Например, ответ для вымышленного проекта, 200 OK:
json
{
"projectId": "dcb2a0e2-5711-4a6f-8dbd-bfa4cf7581e6",
"hasData": true,
"workingPersonalizationCount": 1,
"workingAbTestCount": 0,
"workingRuleBasedActionsCount": 0,
"workingModeledConversions": 1,
"workingAntiBots": 0,
"workingUserSegments": 0,
"workingSurveyCount": 0,
"workingUnifiedFeedCount": 0,
"workingDataStreamingFlowCount": 0,
"activeDemandMapCount": 0,
"workingLeadScoringCount": 0,
"workingProductRecommendationCount": 0,
"goalCount": 3,
"averageSessionsPerDay": 128.5,
"lastSessionGetOnUtc": "2026-01-15T10:00:00Z",
"connectedAdPlatforms": []
}По projectId подтвердите, что выбран нужный проект. По lastSessionGetOnUtc проверьте время последней полученной сессии, по goalCount — число целей. Число работающих сущностей считается отдельно от числа целей.
Найти цели по фильтрам
Используйте GET /public/api/v1/manage/goals с параметрами query или POST /public/api/v1/manage/goals/list с JSON-телом. Например, чтобы найти основные цели с выручкой:
http
GET /public/api/v1/manage/goals?isPrimary=true&isRevenueBearing=true&page=1&pageSize=50json
{
"isPrimary": true,
"isRevenueBearing": true,
"page": 1,
"pageSize": 50
}| Фильтр | Что задаёт |
|---|---|
ids | Оставляет цели с известными UUID. В POST передайте массив. |
search | Ищет цель по названию. |
isPrimary, isBlocked, isRevenueBearing | Фильтры по признакам основной цели, блокировки и наличия выручки. Пропустите фильтр, если подходят оба значения. |
type | Тип цели, например manualCall. |
page, pageSize | Нумерация страниц с 1. Размер по умолчанию 50, максимальный размер 200. |
Оба метода возвращают 200 OK и массив items. Пустой результат выглядит как {"items":[]}. Общего числа записей в ответе нет. Пока ответ содержит полную страницу, запрашивайте следующую.
Получить одну цель
http
GET /public/api/v1/manage/goals/803b2059-11d2-43ba-ad21-2e2e0ad62665Например, 200 OK. Такой же объект возвращается внутри items в ответе на запрос списка.
json
{
"id": "803b2059-11d2-43ba-ad21-2e2e0ad62665",
"name": "Demo purchase",
"type": "manualCall",
"avgDailyConversions": 12.5,
"isPrimary": true,
"isBlocked": false,
"isRevenueBearing": true,
"revenueIsConstantDefault": false,
"isDeletedFromSource": false
}Если цель не найдена, сверьте её ID и токен проекта. При неверном фильтре прочитайте ошибку управления и проверьте указанное поле. Для передачи события в существующую цель используйте приём конверсий.