Path to Conversion API
Path to Conversion API предоставляет детальную информацию о пути пользователя к конверсии, включая все медийные касания и целевые события. API помогает анализировать customer journey и понимать, какие точки контакта влияют на конверсию.
Endpoint
URL, по которому отправляются запросы к API
POST /v1/reports/path_to_conversion?project_id={project_id}
Параметры запроса
Query-параметры
__________________________________________________________________________________

`project_id` (обязательный) - ID проекта
Тело запроса
{
  "ResponseType": "JSON",
  "Fields": [
    "InteractionTime",
    "InteractionType",
    "InteractionMediaCampaignName",
    "TargetEventName"
  ],
  "InteractionFilter": {
    "DateFrom": "2024-01-01",
    "DateTo": "2024-01-31"
  },
  "TargetFilter": {
    "DateFrom": "2024-01-01",
    "DateTo": "2024-01-31",
    "EventType": ["Purchase"]
  },
  "Offset": 0,
  "Limit": 10000
}
Параметры тела запроса
__________________________________________________________________________________
  • Обязательно указать хотя бы один из фильтров: `InteractionFilter` или `TargetFilter` (с заполненными DateFrom и DateTo)
InteractionFilter
__________________________________________________________________________________
! Обратите внимание: `InteractionType` — это строка (string), а не массив. Допустимые значения: `PageView`, `Impression`.
TargetFilter
__________________________________________________________________________________
Доступные поля
Поля взаимодействий
___________________________________________________________________________
Поля целевых событий
___________________________________________________________________________
E-commerce поля
___________________________________________________________________________
Веса атрибуции
___________________________________________________________________________
Примеры запросов
Базовый анализ пути к покупке
curl -X POST "https://api.targetads.io/v1/reports/path_to_conversion?project_id=11111" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ResponseType": "JSON",
    "Fields": [
      "InteractionTime",
      "InteractionType",
      "InteractionMediaCampaignName",
      "TargetEventName",
      "TargetEcomAmount",
      "MLI30"
    ],
    "InteractionFilter": {
      "DateFrom": "2024-01-01",
      "DateTo": "2024-01-31"
    },
    "TargetFilter": {
      "DateFrom": "2024-01-01",
      "DateTo": "2024-01-31",
      "EventType": ["Purchase"]
    },
    "Limit": 10000
  }'
Анализ пути с UTM метками
curl -X POST "https://api.targetads.io/v1/reports/path_to_conversion?project_id=11111" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ResponseType": "JSON",
    "Fields": [
      "InteractionTime",
      "InteractionType",
      "InteractionMediaCampaignName",
      "InteractionUtmSource",
      "InteractionUtmMedium",
      "TargetEventName",
      "FL30",
      "MLI30"
    ],
    "InteractionFilter": {
      "UtmSource": ["google", "facebook"]
    },
    "TargetFilter": {
      "DateFrom": "2024-01-01",
      "DateTo": "2024-01-31",
      "EventType": ["Purchase"]
    }
  }'
Формат ответа
Успешный ответ
{
  "data": [
    {
      "InteractionTime": "2024-01-15 10:30:00",
      "InteractionType": "Impression",
      "InteractionMediaCampaignName": "Campaign A",
      "TargetEventName": "Purchase",
      "TargetEcomAmount": "1500.00",
      "MLI30": "0"
    },
    {
      "InteractionTime": "2024-01-15 18:20:00",
      "InteractionType": "Click",
      "InteractionMediaCampaignName": "Campaign C",
      "TargetEventName": "Purchase",
      "TargetEcomAmount": "1500.00",
      "MLI30": "1"
    }
  ],
  "count": 2
}
Ошибка валидации
{
  "ErrorCode": 400,
  "ErrorMessage": "validate error",
  "Errors": [
    {
      "Error": true,
      "FailedField": "Interaction or Target DateTo and DateFrom is required",
      "Value": ""
    }
  ]
}

Лимиты и ограничения


API имеет технические ограничения, которые следует

учитывать при построении интеграции:


Максимум записей: 100 000
Минимум полей: 3
Максимум значений в фильтре:
- MediaCampaignId/MediaPlacementId: 20
Rate limit: 40 запросов в минуту на project_id
InteractionType: только `PageView` или `Impression` (string, не array)
Обязательно указать хотя бы один фильтр с датами

Таймаут: 300 секунд

Коды ошибок
Пример выгрузки