API документация

API токен представляет из себя набор случайных знаков латиского алфавита и цифр, длиной 60 символов.

Управлять токенами можно на странице аккаунта. Так же там находится небольшая статистика по их использованию.

Максимальное кол-во токенов для одного аккаунта = 5.

Существует ограничение на кол-во запросов с одного IP-адреса. Не более 60 запросов в минуту, иначе сервер вернёт ответ с кодом 429 - "Too Many Attempts."

Важно! Не передавайте токен в строке URL - если кто-то перехватит ваш трафик, то сможет управлять вашими кампаниями и т.д.

Это делать можно, но крайне не рекомендуется. В POST запросе можно передавать токен вместе с остальными параметрами, так же можно использовать Bearer Token

Описанная в этом блоке информация распространяется абсолютно на все методы API.

Основное:

  • Метод - GET/POST
  • Формат ответа - JSON

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

  • api_token* - api токен

Параметры, возвращаемые сервером:

  • success - результат выполнения (1 - удачно, 0 - неудачно)
  • status_code - http код ответа сервера (например, 200 - удачно, а 403 - нет доступа)
  • msgs - массив с сообщениями. Включает в себя:
    • error - массив с ошибками (строки)
    • success - массив с подтверждением удачных операций (строки)
    • warning - массив с предупреждениями (строки)
    • info - массив с доп. информацией (строки)

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/balance

Параметры, возвращаемые сервером:

  • response* - массив, содержащий следующие поля:
    • balance - массив, который включает в себя:
      • web - баланс вебмастера
      • adv - баланс рекламодателя
      • par - баланс партнёра
      • general - общий баланс

Основное:

  • URL - https://bigclick.me/api/v2/get-currencies-rate

Параметры, возвращаемые сервером:

  • response* - массив, содержащий следующие поля:
    • total - кол-во элементов всего
    • data - массив, который включает в себя:
      • currency - валюта (3 символа по стандарту ISO 4217)
      • rate - курс (вещественное число)

Основное:

  • URL - https://bigclick.me/api/v2/balance-transactions

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

  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • data - массив, содержащий следующие поля:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id транзакции
        • amount - сумма (USD)
        • from - откуда (строка)
        • to - куда (строка)
        • comment - комментарий к транзакции, оставленный пользователем
        • admin_comment - комментарий к транзакции, оставленный админом
        • status - статус транзакции кодом (1 - В процессе, 2 - Отклонено, 3 - Успешно)
        • status_name - статус транзакции строкой на русском языке
        • created_at - дата и время создания транзакции (например, 2020-04-20 20:42:54)
        • updated_at - дата и время последнего обновления транзакции

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/send-money

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

  • user_id* - id пользователя в системе BigClick.me (целое число). Обязательный параметр, когда не указан email
  • email* - e-mail пользователя в системе BigClick.me. Обязательный параметр, когда не указан user_id
  • coupon_code* - код купона
  • amount* - сумма перевода (целое число)
  • unique_trans_id - строка со случайным набором символов, длинной от 60 до 200, которая будет защищать от повторного начисления средств при сбое

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns

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

  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • campaigns - массив, содержащий следующие поля:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id кампании
        • name - название кампании
        • ad_type_id - id рекламного формата
        • click_num - номер клика, за который конкурирует кампания (для формата кликандер). (1 - 1ый клик, 2 - 2ой клик, 100 - 3ий и последующие клики)
        • status - статус кампании кодом (1 - идут показы, 2 - приостановлена)
        • status_name - статус кампании строкой на русском языке
        • ads_paused_count - кол-во тизеров на паузе
        • ads_active_count - кол-во активных тизеров
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • spent - потрачено денег за текущий день по МСК

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/ads

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

  • {id}* - id кампании
  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • ads - массив, содержащий следующие поля:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id тизера
        • campaign_id - id кампании
        • ad_type_id - id рекламного формата
        • click_num - номер клика, за который конкурирует кампания, в которую входит ссылка (для формата кликандер). (1 - 1ый клик, 2 - 2ой клик, 100 - 3ий и последующие клики)
        • image - ссылка на изображение тизера, если тизер
        • text - текст тизера, если тизер
        • url - ссылка на лендинг
        • status - статус тизера кодом (1 - заблокирован, 2 - на модерации, 3 - приостановлен, 4 - активен)
        • status_name - статус тизера строкой на русском языке
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • spent - потрачено денег за текущий день по МСК

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/pause

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

  • {id}* - id кампании

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/play

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

  • {id}* - id кампании

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/stat

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

  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив с сайтами, который включает в себя:
      • campaign_id - id кампании
      • info - краткая информация о кампании, включает в себя следующие поля:
        • is_active - информация об активности кампании (true/false)
        • ad_type_id - id рекламного формата
      • stat - массив со статистикой сайта по указанным датам (один элемент - один день), который включает в себя:
        • date - дата в фаормате d/m/Y (строка)
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • spent - затраты

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/stat-by-site

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

  • {id}* - id кампании
  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив со статистикой по сайтам (id элемента = id сайта), который включает в себя:
      • массив по датам, где id элемента - это дата (строкой), и каждый элемент включает в себя статистику массивом:
        • site_id - id сайта
        • date - дата
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • spent - расходы

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/add-sites-to-black

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

  • {id}* - id кампании
  • site_ids* - id сайтов, разделенных запятой

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/remove-sites-from-black

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

  • {id}* - id кампании
  • site_ids* - id сайтов, разделенных запятой

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/add-sites-to-white

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

  • {id}* - id кампании
  • site_ids* - id сайтов, разделенных запятой

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/remove-sites-from-white

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

  • {id}* - id кампании
  • site_ids* - id сайтов, разделенных запятой

* - обязательные параметры

Основное:

  • чёрный список игнорируется, если указан белый
  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/get-black-and-white-list

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

  • {id}* - id кампании

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • black - массив с id сайтов, находящихся в чёрном списке
    • white - массив с id сайтов, находящихся в белом списке

* - обязательные параметры

Основное:

  • ставка кликандер-кампаний должна быть выше каждой из индивидуальных, указанных через метод campaigns.set-site-prices
  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/set-price

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

  • {id}* - id кампании
  • cpm_price* - CPM ставка в USD
  • cpm_price_from - CPM ставка "от" в USD (применима только для тизерной кампании)
  • is_reduce_site_prices - нужно ли понижать индивидуальные ставки до основной ставки, если они больше основной ставки. Принимаются значения 1 или 0. Дефолтное значение - 0

* - обязательные параметры

Основное:

  • индивидуальные ставки можно указать только для кликандер-кампаний (ad_type_id = 2)
  • основная ставка должна быть выше индивидуальной (индивидуальные ставки могут только занижаться)
  • если переданная индивидуальная ставка равна нулю, то эта ставка для сайта удаляется
  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/set-site-prices

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

  • {id}* - id кампании
  • site_ids* - id сайтов, разделенных запятой
  • cpm_prices* - CPM ставки, разделенные запятой. 1ая цена соответствует 1ому ID сайта, 2ая соответствует 2ому и т.д.
  • is_reset - нужно ли удалять ставки, которые не переданы в данном запросе (старые). Принимаются значения 1 или 0. Дефолтное значение - 0

* - обязательные параметры

Основное:

  • индивидуальные ставки могут быть указаны только для кликандер-кампаний (ad_type_id = 2)
  • основная ставка должна быть выше индивидуальной (индивидуальные ставки могут только занижаться)
  • URL - https://bigclick.me/api/v2/advertiser/campaigns/{id}/get-site-prices

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

  • {id}* - id кампании

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • site_prices_cpm - ассоциативный массив с CPM ставками для сайтов вида {id_сайта: CPM цена}

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads

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

  • page - страница (от 1 и до бесконечности)
  • per_page - кол-во элементов на страницу ([10,20,30,50,70,100,200,300,400,500])

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • ads - массив, содержащий следующие поля:
      • total - кол-во элементов всего
      • per_page - кол-во элементов на одну страницу
      • current_page - текущая страница
      • last_page - последняя страница
      • next_page_url - ссылка на следующую страницу (null - если отсутствует или строка - если присутствует)
      • prev_page_url - ссылка на предыдущую страницу (null - если отсутствует или строка - если присутствует)
      • from - номер элемента с которого начинается показ данной страницы
      • to - номер элемента на котором закнчивается показ данной страницы
      • data - массив, где перечисляются элементы:
        • id - id тизера
        • campaign_id - id кампании
        • ad_type_id - id рекламного формата
        • click_num - номер клика, за который конкурирует кампания, в которую входит ссылка (для формата кликандер). (1 - 1ый клик, 2 - 2ой клик, 100 - 3ий и последующие клики)
        • image - ссылка на изображение тизера, если тизер
        • text - текст тизера, если тизер
        • url - ссылка на лендинг
        • status - статус тизера кодом (1 - заблокирован, 2 - на модерации, 3 - приостановлен, 4 - активен)
        • status_name - статус тизера строкой на русском языке
        • views - кол-во просмотров за текущий день по МСК
        • clicks - кол-во кликов за текущий день по МСК
        • ctr - CTR за текущий день по МСК
        • spent - потрачено денег за текущий день по МСК

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads/{id}/pause

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

  • {id}* - id тизера

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads/{id}/play

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

  • {id}* - id тизера

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • ставка ссылки кликандер-кампании должна быть выше каждой из индивидуальных, указанных через метод campaigns.set-site-prices
  • URL - https://bigclick.me/api/v2/advertiser/ads/{id}/set-price

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

  • {id}* - id рекламного материала
  • cpm_price* - CPM ставка в USD
  • cpm_price_from - CPM ставка "от" в USD (применима только для тизерного формата рекламы)

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads/competitive

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

  • ad_type_id - id рекламного формата (по умолчанию 1 - тизеры, 2 - кликандер)
  • click_num - номер клика, по которому сравнивать конкуренцию (для формата кликандер). (1 - 1ый клик, 2 - 2ой клик, 100 - 3ий и последующие клики)
  • country - id страны
  • oss - id оператора
  • platform - операционная система, возможные значения: windows, mac_os, android, ios, others

Параметры, возвращаемые сервером:

  • response - массив с элементами (кол-во от 0 до 20), который включает в себя:
    • position - позиция в топе (целое число)
    • is_yours - ваш ли это рекламный материал (true или false)
    • ad_id - id рекламного материала (0 если он не ваш, или это ссылка кликандер-кампании)
    • campaign_id - id кампании (0 если это не ваша кампания)
    • good_type - тип конечной цели (строка)
    • views - кол-во просмотров за всё время (0 если это не ваша кампания)
    • clicks - кол-во кликов за всё время (0 если это не ваша кампания)
    • ctr - CTR (от 0 до 100; 0 если это не ваша кампания)
    • cpm - CPM (в USD)
    • price - ставка (в USD; 0 если это не ваша кампания)
    • volume - охват/объем выкупаемого трафика в процентах от общего объема трафика по текущим фильтрам (статистика за последние 10 мин)

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads/stat

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

  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив с сайтами, который включает в себя:
      • ad_id - id рекламного материала
      • info - краткая информация о кампании, включает в себя следующие поля:
        • is_active - информация об активности рекламного материала (true/false)
        • ad_type_id - id рекламного формата
      • stat - массив со статистикой сайта по указанным датам (один элемент - один день), который включает в себя:
        • date - дата в фаормате d/m/Y (строка)
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • spent - затраты

* - обязательные параметры

Основное:

  • под рекламными материалами понимаются тизеры для тизерных кампаний, ссылки для кликандер кампаний и т.п.
  • URL - https://bigclick.me/api/v2/advertiser/ads/{id}/stat-by-site

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

  • {id}* - id рекламного материала
  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив со статистикой по сайтам (id элемента = id сайта), который включает в себя:
      • массив по датам, где id элемента - это дата (строкой), и каждый элемент включает в себя статистику массивом:
        • site_id - id сайта
        • date - дата
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • spent - расходы

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/webmaster/sites/stat

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

  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во сайтов, которые перечислены в массиве data
    • data - массив с сайтами, который включает в себя:
      • site_id - id сайта
      • stat - массив со статистикой сайта по указанным датам (один элемент - один день), который включает в себя:
        • date - дата в фаормате d/m/Y (строка)
        • views - кол-во просмотров
        • clicks - кол-во кликов
        • ctr - CTR
        • profit - прибыль

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/stat-detailed

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

  • dates* - даты. Например, 09/04/2019-10/04/2019. В формате d/m/Y-d/m/Y
  • site_id - фильтрация по id сайта (целое число)
  • block_id - фильтрация по id блока (целое число)
  • ad_type_id - фильтрация по id формата рекламы (1 - Тизеры, 2 - Кликандер)
  • group_by - группировка по полю (date, site_id, block_id, ad_type_id, country). Если значение не указано, то 'date'

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во записей, которые перечислены в массиве data
    • data - массив со статистикой, где каждый элемент относится к уникальному значению группировки, который включает в себя:
      • {group_by} - имя поля будет тем, которые вы передали в группировке, значение тоже зависит от выбранного параметра группировки (дата, id сайта, id блока и тд)
      • views - кол-во просмотров
      • clicks - кол-во кликов
      • ctr - CTR
      • profit - прибыль

* - обязательные параметры

Основное:

  • URL - https://bigclick.me/api/v2/countries

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во стран, которые перечислены в массиве data
    • data - массив со странами, каждый элемент включает в себя:
      • id - id страны
      • name - название старны

Основное:

  • URL - https://bigclick.me/api/v2/operators

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во операторов, которые перечислены в массиве data
    • data - массив с операторами, каждый элемент включает в себя:
      • id - id оператора
      • name - название оператора

Основное:

  • URL - https://bigclick.me/api/v2/ad-types

Параметры, возвращаемые сервером:

  • response - массив, содержащий следующие поля:
    • total - кол-во операторов, которые перечислены в массиве data
    • data - массив с операторами, каждый элемент включает в себя:
      • id - id формата
      • name - название формата

Документация по прошлой версии API находится здесь.