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

Трекинг лидов

Чат трекинг

Интеграции

CRM системы

Мессенджеры

Другие интеграции

Импорт расходов

Настройки кабинета

Методы и ресурсы API в Alfa-Track

Введение

			
API Endpoint
https://cloud.alfa-track.com/

Alfa-Track API предоставляет программный доступ к информации об обращениях, полученных сервисом. Кабинет Alfa-Track может включать множество проектов. API работает в рамках одного проекта.

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

МЕТОД GET LEADS


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

curl -G GET \
'https://cloud.alfa-track.com/user/open/api/v1/leads' \
-H "Content-type: application/json" \ -H "Accept: application/json" \ -d token=lndGVJbmZGS3dffVksyDMqijqw \ -d from=2021-01-01 \ -d to=2021-01-31 \ -d attribution_model=FIRST_INTERACTION \ -d analytic_system=GOOGLE_ANALYTICS

Чтобы получить информацию об обращениях, необходимо сделать GET запрос на следующий url:

https://cloud.alfa-track.com/user/open/api/v1/leads


ПАРАМЕТРЫ ЗАПРОСА

Имя Обязательный Описание
token да Ваш API ключ
from да дата "от", указывается в формате ГГГГ-ММ-ДД
to да дата "по", указывается в формате ГГГГ-ММ-ДД, не может равняться сегодняшнему дню
attribution_model да модель атрибуции, может быть:
FIRST_INTERACTION (первое взаимодействие);
LAST_INTERACTION (последнее взаимодействие);
LAST_NON_DIRECT_CLICK (последний не прямой клик);
LAST_PAID_CLICK (последний платный клик);
analytic_system да определяет источник данных, может быть GOOGLE_ANALYTICS или YANDEX_METRIKA

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

{
   "success":true,
   "object":[
      {
         "name":"Moiseenkov, Dmitriy",
         "gacid":"1372806527.1600149950",
         "id":1953592530,
         "msgRealId":"<07e@nmk.com>",
         "ymcid":"1600149950687070718",
         "sendDate":1610434297000,
         "email":"monkov@nelmk.com",
         "subject":"задвижки CMO",
         "message":"Здравствуйте! Просим..",
         "ip":"91.229.189.248",
         "source":"yandex.ru",
         "medium":"referral",
         "campaign":"(not set)",
         "keyword":"(not set)",
         "socialNetwork":"(not set)",
         "adContent":"(not set)",
         "fullReferrer":"yandex.ru/",
         "city":"Lipetsk",
         "dateHourMinute":"202009150905",
         "sessionId":"1",
         "outVisitorId":"1427830.1600952",
         "outSessionId":"774153027",
         "outHitId":"1600149952326",
         "searchPhrase":null,
         "browser":"Chrome",
         "country":"Russia",
         "deviceCategory":"desktop",
         "pagePath":"/about/",
         "analyticSystem":"GOOGLE_ANALYTICS"
      },
      {
         "name":"Александр Кобзин",
         "gacid":"434111606.1610456462",
         "id":1196574471,
         "msgRealId":"<161.609@f40.i.mail.ru>",
         "ymcid":"1610456463181945503",
         "sendDate":1610457799000,
         "email":"kobzin@metserv.ru",
         "subject":"Приобретение металл..",
         "message":"Добрый день.\nПрошу..",
         "ip":"94.141.188.212",
         "source":"google",
         "medium":"organic",
         "campaign":"(not set)",
         "keyword":"(not provided)",
         "socialNetwork":"(not set)",
         "adContent":"(not set)",
         "fullReferrer":"google",
         "city":"Moscow",
         "dateHourMinute":"202101121602",
         "sessionId":"1",
         "outVisitorId":"5826817.16104526",
         "outSessionId":"885808498",
         "outHitId":"1610456463907",
         "searchPhrase":null,
         "browser":"Chrome",
         "country":"Russia",
         "deviceCategory":"mobile",
         "pagePath":"/about/",
         "analyticSystem":"GOOGLE_ANALYTICS"
      }
   ]
}
                

ПАРАМЕТРЫ ОТВЕТА

Имя Описание
name Имя адресата(лида, включает ФИО, если доступно)
gacid Идентификатор посетителя в Google Аналитике
id Идентификатор обращения в Alfa-Track
msgRealId Идентификатор письма в почтовом ящике(при наличии)
ymcid Идентификатор посетителя в Яндекс.Метрике
sendDate Дата отправки письма/запроса через форму обратной связи
email Емеил адрес лида
subject Тема письма/обращения
message Текст письма/обращения
ip IP адрес посетителя сайта
source Значение utm_source или источник, установленный не через get параметр(например из связи Ads+GA)
medium Значение utm_medium или тип трафика, установленный не через get параметр(например из связи Ads+GA)
campaign Значение utm_campaign или кампания, установленная не через get параметр(например из связи Ads+GA)
keyword Значение utm_keyword или ключевое слово, которое инициировало показ объявления, установленное не через get параметр(например из связи Ads+GA)
socialNetwork Социальная сеть, из которой перешел посетитель
adContent Значение utm_content или содержание, которое инициировало показ объявления, установленное не через get параметр(например из связи Ads+GA)
fullReferrer Адрес веб-сайта, из которого перешел посетитель
city Город посетителя
dateHourMinute Дата посещения в формате ГГГГММДДЧЧММ
sessionId Идентификатор сессии посетителя
outVisitorId Идентификатор посетителя от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic
outSessionId Идентификатор сессии посетителя от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic
outHitId Идентификатор запроса от системы веб-аналитики, с которой произведена интеграция, например CallTouch,Comagic
searchPhrase Поисковый запрос одной из поисковых систем
browser Браузер посетителя
country Страна посетителя
deviceCategory Устройство посетителя
pagePath Страница, на которой находился посетитель
analyticSystem Система аналитики, которая использовалась в качестве источника данных

	
# Пример ошибки:
		
{
   "success":false,
   "httpStatus":"NOT_FOUND",
   "errorCode":"40000",
   
"errorMessage":"USER by token=WUxrTG9jN3Z1OWloNkpLZ3NuQmlIZz0 doesn't exist"
}

Ошибки

Alfa-Track API использует следующие коды ошибок:

Код Значение
500 Какой-то параметр упущен. Ошибка возникает если указано некорректное значение параметра или обязательный параметр отсутствует.
503 Сервис недоступен. Ведутся технические работы или происходит обновление системы.

Лимиты и ограничения

API работает в рамках одного Alfa-Track проекта.

Имеется ограничение на количество запросов в сутки, не более 1000.

Ограничено количество запросов в секунду, не более одного запроса в секунду.