Наверх

Документация ad1 API BETA

GET https://ad1.media/api/goal/

Список целей для оффера(ов)

Входные параметры

Параметр Тип Описание
offer_id int или array_int ID оффера(ов)
is_active bool Показывать только активные цели

Примечание: выделенные параметры являются обязательными.

Пример запроса

GET https://ad1.media/api/goal/?
      offer_id=8,34,14,48,52,21,37
     &per_page=10

Описание ответа

Поле ответа objects содержит список целей, удовлетворяющих заданному фильтру. Необходимо использовать пагинацию.

Поле Описание
id ID цели
offer_id ID оффера, к которому относится эта цель
description Описание цели
is_active Активна ли цель
is_auto_approve Одобряются ли целевые действия автоматически
category Категория цели. Расшифровка кодов:
  • 0 Без категории
  • 1 Просмотр видео
  • 2 Регистрация
  • 3 Активный игрок
  • 4 Подтвержденная регистрация
  • 5 Эффективная регистрация
  • 6 Оплата заказа
  • 7 Подтверждение заказа
  • 8 Подтвержденная заявка
  • 9 Внесение депозита
  • 10 Переход на сайт
  • 11 Подача заявки
  • 12 Установка приложения
  • 13 Оформление заказа
  • 14 Выданный займ
currency_id ID валюты. Полный список используемых валют отдает метод currency / list
lead_count_start Для какого количества первых лидов будет большая оплата
date_created Дата создания цели
is_otol Флаг при котором для одного tid`a может быть только одно действие (one tid one lead)
hold_period Период холда, в днях
money_type Тип оплаты.
  • 1 Фиксированная
  • 2 Процент от покупки
  • 3 Динамическая оплата
payment

Значение поля следует интерпретировать по-разному, в зависимости от значения money_type.

Если money_type == 1, то есть оплата фиксированная, значит поле payment содержит конкретную сумму в валюте currency_id.

Если money_type == 2, то есть оплата выражена в процентах от суммы сделки, то поле содержит количество процентов.

Если money_type == 3, то есть сумма зависит от решения рекламодателя, то поле будет содержать структуру со статистикой выплат по этой цели:

  • min Минимальная зарегистрированная сумма
  • max Максимальная сумма
  • avg Среднаяя сумма выплат