Работа с кампаниями

Список кампаний

INFO

GET /campaigns

Пример использования:

https://client.adstat.pro/api/campaigns/?period=today&limit=50&offset=0

Описание query-параметров:

Параметр	Тип	Описание
period	Строка	Период времени, за который необходимо получить данные по кампаниями. Значения могут быть - today ( За сегодня ) , all ( За весь период ), yesterday (За вчера) , starts_month ( За текущий месяц ).
offset	Число	Смещение в результирующем списке кабинетов.
limit	Число	Максимальное количество кабинетов в ответе.
campaign_name	Строка	Название кампании, по которой нужно фильтровать кабинеты.
is_active	Boolean	Статус, по которому нужно фильтровать кабинеты. Значения могут быть - true ( статус кампании "Активна" ) , false ( статус кампании "Неактивна" ). Если не передавать значение - в таком случае будут возвращаться все кампании, в обоих статусах.

Пример успешного ответа:

{
  "items": [
    {
      "id": 999999,
      "name": "example",
      "description": "",
      "account_id": "ACC000000",
      "account_name": "SOME_test",
      "status": "not_active",
      "number_of_advertisements": 2,
      "goals": 0,
      "impressions": 0,
      "budget": 0.01,
      "cps": 0,
      "cpm": 0,
      "ctr": 0,
      "cpc": 0,
      "clicks": 0,
      "spent": 0
    }
  ],
  "count": 0
}

Описание параметров успешного ответа:

Поле	Тип	Описание
items	Массив	Список объектов с информацией о рекламных кампаниях.
id	Число	Уникальный идентификатор кампании.
name	Строка	Название кампании.
description	Строка	Описание кампании.
account_id	Строка	Уникальный идентификатор кабинета, к которому относится кампания.
account_name	Строка	Название кабинета, к которому относится кампания.
status	Строка	Статус кампании.
number_of_advertisements	Число	Количество объявлений в кампании.
goals	Число	Количество целей, достигнутых в кампании.
impressions	Число	Количество просмотров объявлений.
budget	Число	Бюджет кампании.
cps	Число	Стоимость за цель (CPS).
cpm	Число	Стоимость тысячи просмотров (CPM).
ctr	Число	Коэффициент кликабельности (CTR).
cpc	Число	Стоимость за клик (CPC.
clicks	Число	Количество кликов на объявления.
spent	Число	Общая сумма потраченных средств на кампанию.
count	Число	Количество кампаний в списке.