Описание

Получение списка заказов.

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

https://vkserfing.ru/api/campaign.get?token=a56a7e1rwr358ee0c14c0e58d992da436

Пример ответа:

{
  "status": "success",
  "data": {
    "total": 1,
    "count": 1,
    "list": [
      {
        "id": 363187,
        "parent_id": 0,
        "name": "ere",
        "type": "vk_community",
        "insurance": "off",
        "link": "https://vk.com/club1",
        "adult": "off",
        "time": "2018-06-05 19:31:13",
        "status": "on",
        "vote_type": "custom",
        "votes": [
            { "index": 3, "votes": 10 },
            { "index": 5, "votes": 20 },
        ],
        "comments_type": "custom",
        "comments": [
            { "text": "test comment" }
        ],
        "targeting": {
          "sex": 0,
          "relation": 0,
          "age_from": 0,
          "age_to": 999,
          "friends_from": 0,
          "friends_to": 9999,
          "subscribes_from": 0,
          "subscribes_to": 9999,
          "profile_photos_from": 0,
          "profile_photos_to": 999,
          "records_from": 0,
          "records_to": 99999,
          "month_reg_period": 0,
          "limit_per_day": 480,
          "automatic_records_limit": 0,
          "country": [
              {
                  "id": 1,
                  "name": "Россия"
              },
              {
                  "id": 2,
                  "name": "Украина"
              },
              {
                  "id": 3,
                  "name": "Беларусь"
              }
          ],
          "city": null
        },
        "money": {
          "spent": 5,
          "per_user": 0.5
        },
        "users": {
          "limit_total": 20,
          "limit_reserve": 18,
          "limit_system_per_hour": 8,
          "users_limit_random": "off",
          "automatic_current": 0,
          "automatic_records": 0,
          "current": 20,
          "current_reserve": 15,
          "left": 3,
          "members_before": 142
        },
        "project": null
      }
    ]
  }
}
Параметры
Название Описание
count Количество записей, необходимое получить. Не может превышать значение 200. По умолчанию 10
offset Смещение, необходимое для выборки определенного подмножества записей. По умолчанию 0
id Поиск по ID заказа. Можно указывать как единичный ID, так и перечисление. Для передачи нескольких ID они должны быть разделены запятой.
Пример: 345440,827230,52542
parent_id ID главного задания (автозаказы), от которого создаются автоматические подзадания
platform Соцсеть задания
Может принимать следующие значения:
  • vk - ВКонтакте
  • instagram - Instagram
  • tiktok - Тик Ток
  • likee - Likee
  • telegram - Telegram
type Тип заданий. Возможные значения
project_id ID папки. Выводит задания которые вложены в указанную папку
status Статус фильтруемых заказов.
Допустимые значения:
  • on - Активные
  • pause - Остановленные
  • finished - Завершенные
  • in_queue - В очереди
  • moderated - На модерации
  • banned - Заблокированные
  • delete - В архиве
insurance Страховка. Возможные значения
  • on - включена
  • off - выключена
По умолчанию - off.
adult Материалы для взрослых (18+).
Может принимать следующие значения:
  • on - включен режим 18+
  • off - выключен
По умолчанию - off.
users_from Минимальное значение человек которое выполнило задания
users_to Максимальное значение человек которое выполнило задания
date_from Минимальная дата создания задания. Формат DD.MM.YYYY
date_to Максимальная дата создания задания. Формат DD.MM.YYYY
fields Дополнительные поля. Перечисляются через запятую.
Список дополнительных полей:
  • members_before - количество участников у заказа до начала выполнения
  • preview - превью заказа (изображение профиля/группы/страницы)
Параметры ответа
Название Описание
total Общее количество найденных результатов. Используется для организации постраничного вывода
count Количество возращаемых результатов
Объект списка (list). Общая информация.
id ID заказа
parent_id ID главного задания (автозадания), от которого создаются автоматические подзадания
name Название
type Тип задания.
Возможные значения
insurance Страховка.
Может принимать следующие значения:
  • on - включена
  • off - выключена
adult Материалы для взрослых (18+).
Может принимать следующие значения:
  • on - содержит
  • off - не содержит
time Дата создания заказа.
status Статус заказа.
Может принимать следующие значения:
  • on - Активные
  • pause - Остановленные
  • finished - Завершенные
  • in_queue - В очереди
  • moderated - На модерации
  • banned - Заблокированные
  • delete - В архиве
link Ссылка на задание
vote_type Тип голосования
Может принимать следующие значения:
  • custom - указанные варианты
  • any - любой вариант голосования
votes Номера вариантов голосования и количество голосующих
Пример массива:
[ { id: 997, index: 1, votes: 10 }, { id: 998, index: 2, votes: 20 } ]
тут находятся следующие данные:
  • id - системный id варианта голосования
  • index - номер варианта голосования от начала
  • votes - количество требуемых голосов
comments_type Тип комментариев
Может принимать следующие значения:
  • positive -позитивные
  • neutral - нейтральные
  • any - любые
  • custom - указанные
comments Комментарии для публикации
Пример массива:
[ { text: 'первый комментарий' }, { text: 'второй комментарий' } ]
тут находятся следующие данные:
  • text - текст комментария
like_comment_user Юзернейм комментируемого пользователя, комментарий которого нужно лайкнуть
Только для заданий с типом instagram_like
stories_to_view Количество сторис для просмотра
Только для заданий с типом instagram_view_history
estimated_finish_time Расчетное время выполнения заказа.
Опциональное поле. Выводится при указании его в параметре fields
Объект таргетинга (list — targeting). Параметры таргетирования.
sex Пол аудитории.
Может принимать следующие значения:
  • 0 - любой
  • 1 - женский
  • 2 - мужской
relation Семейное положение.
Может принимать следующие значения:
  • 1 - не женат / не замужем
  • 2 - есть друг / есть подруга
  • 3 - помолвлен / помолвлена
  • 4 - женат / замужем
  • 5 - все сложно
  • 6 - в активном поиске
  • 7 - Влюблен / влюблена
age_from Минимальный возраст исполнителя
age_to Максимальный возраст исполнителя
friends_from Минимальное количество друзей у исполнителя
friends_to Максимальное количество друзей у исполнителя
subscribes_from Минимальное количество подписок у исполнителя
subscribes_to Максимальное количество подписок у исполнителя
profile_photos_from Минимальное количество фотографий профиля у исполнителя
profile_photos_to Максимальное количество фотографий профиля у исполнителя
records_from Минимальное количество записей на странице исполнителя
records_to Максимальное количество записей на странице исполнителя
month_reg_period Минимальное количество месяцев с момента регистрации исполнителя
limit_per_day Лимит исполнителей в сутки
automatic_records_limit Количество новых постов
0 - без ограничений
Только для автоматических типов заказов
Объект средств (list — money). Информация о расходе средств.
spent Израсходовано средств
per_user Стоимость одного исполнителя
Объект исполнителей (list — users). Информация о выполнении.
limit_total Количество заказанных исполнителей
limit_reserve Количество бесплатных запасных исполнителей
limit_system_per_hour Системная скорость исполнителей в час
current Текущее количество выполнений от заказанного числа
current_reserve Текущее количество выполнений от запаса
left Количество оставшихся выполнений

При реализации функционала отмены/блокировки заказов в вашей системе, остаток выполнений расчитывайте по формуле: limit_total - current. Это важно, т.к. расчет остатка по left будет неверным.

Для примера, в нашем ЛК мы выводим количество выполнений в таком виде:
Выполнено: 75 из 90 (60),
где 60 – это заказано (limit_total), 90 – это с запасом (limit_total + limit_reserve), 75 – это выполнений суммарно с запасами (current + current_reserve). В нашем ЛК мы суммируем значения запасов с изначально заказанным количеством, чтобы не было недопонимания со стороны рекламодателей, почему заказ имеет статус "активен", но изначально заказанное число выполнений уже достигнуто.

В вашей системе вы можете воспользоваться нашим примером, либо вместо всего этого выводить лишь остаток выполнений – left. Он динамический, учитывает и заказанное число, и запасы (выше есть объяснение, как он рассчитывается).
users_limit_random Варьировать количество исполнителей
Значения:
  • on - включено
  • off - выключено
Только для автоматических типов заданий
automatic_current Суммарное количество выполнений по всем подзаданиям
Только для автоматических типов заданий
automatic_records Количество созданных позаданий
Только для автоматических типов заданий
members_before Количество пользователей по ссылке до начала выполнения заказа
Опциональное поле. Выводится при указании его в параметре fields
preview Превью заказа (изображение профиля/группы/страницы)
Опциональное поле. Выводится при указании его в параметре fields
speed_per_day Скорость выполнения заказа. Пользователей в день.
Опциональное поле. Выводится при указании его в параметре fields
Объект папки проекта (list — project)
id ID папки
name Название папки