Кампании в системе Call-Tracking имеют различные настройки: только для мобильных, сайты для которых применяется и т.д. Получить информации о активных кампаниях пользователя можно следующим образом:

URL: GET /crm_api/v1/stats/get_campaigns_info.json

Обязательные параметры:

  • user_token - Секретный ключ пользователя.
  • start_date - Дата начала запрашиваемого периода. Формат день-месяц-год. Пример: '01-07-2015'.
  • end_date - Дата окончания запрашиваемого периода. Формат день-месяц-год. Пример: '31-07-2015'.

Необязательные параметры:

  • adv_group_ids - Если указан, то только информация о кампаниях, указанных групп будет предоставлена. Формат - строка (идентификаторы групп через запятую).
  • adv_campaign_ids - Если указан, то только информация о кампаниях, указанных идентификаторов будет предоставлена. Формат - строка (идентификаторы кампании через запятую).

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

/crm_api/v1/stats/get_campaigns_info.json?user_token=TsMbF1mGyiEWejBJ2eOh_w&start_date=01-07-2015&end_date=03-07-2015&adv_group_ids=1,2,3

    
      var group_ids = [1,2,3];
      requestUrl = '/crm_api/v1/stats/get_campaigns_info.json?user_token=TsMbF1mGyiEWejBJ2eOh_w&start_date=01-07-2015&end_date=03-07-2015&adv_group_ids=' + group_ids.join(',')
      $.get(requestUrl, function (data) {
        $('.response-example').removeClass('loading-data');
        $('.response-example').html(JSON.stringify(data, null, 4))
      })
    
 

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

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

  • id - идентификатор кампании.
  • name - имя кампании.
  • start_date - дата начала кампании.
  • end_date - дата окончания кампании.
  • site_urls - сайты, на которые распространяется действия кампании. (например у клиента 2 сайта и на каждом из них есть кампания Яндекс, но отслеживание должно вестись раздельно)
  • page_regexp - страницы сайта на которых применяется кампания кампании.
  • adv_campaign_group_id - идентификатор группы, к которой принадлежит кампания.
  • dynamic - является ли кампания динамической (обратитесь к менеджеру за разъяснением).
  • online - является ли кампания онлайн (обратитесь к менеджеру за разъяснением).
  • mobile - является ли кампания для мобильных устройств (обратитесь к менеджеру за разъяснением).
  • phones - телефонные номера которые используются в кампании.
  • status - текущий статус кампании (может быть подтвержденным и неподтвержденным).

Возможное практическое применение:

Для создания информационной страницы с настройками кампании. Например следующего вида:

Settings page