Введение

			
 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

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

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

{
   "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",
         "integrationId": null,
         "outVisitorId":"1427830.1600952",
         "outSessionId":"774153027",
         "outHitId":"1600149952326",
         "searchPhrase":null,
         "browser":"Chrome",
         "country":"Russia",
         "deviceCategory":"desktop",
         "pagePath":"/about/",
         "analyticSystem":"GOOGLE_ANALYTICS",
         "tags": null,
         "customId":"942348510"
      },
      {
         "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",
         "integrationId": null,
         "outVisitorId":"5826817.16104526",
         "outSessionId":"885808498",
         "outHitId":"1610456463907",
         "searchPhrase":null,
         "browser":"Chrome",
         "country":"Russia",
         "deviceCategory":"mobile",
         "pagePath":"/about/",
         "analyticSystem":"GOOGLE_ANALYTICS",
         "tags": null,
         "customId":"942348590"
      }
   ]
}
                

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

МЕТОД GET LEAD VISIT

# Пример CURL запроса
                
curl -G GET \
'https://cloud.alfa-track.com/user/open/api/v1/lead/visit' \
-H "Content-type: application/json" \
-H "Accept: application/json" \
-d token=lndGVJbmZGS3dffVksyDMqijqw \
-d email=monkov@nelmk.com \
-d attribution_date_to=2021-01-01 \
-d attribution_model=FIRST_INTERACTION \
-d analytic_system=GOOGLE_ANALYTICS
                

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

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

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

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

{
   "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",
         "integrationId": null,
         "outVisitorId":"1427830.1600952",
         "outSessionId":"774153027",
         "outHitId":"1600149952326",
         "searchPhrase":null,
         "browser":"Chrome",
         "country":"Russia",
         "deviceCategory":"desktop",
         "pagePath":"/about/",
         "analyticSystem":"GOOGLE_ANALYTICS",
         "tags": null,
         "customId":"942348510"
      }
}
                

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

# Пример ошибки:

{
   "success":false,
   "httpStatus":"NOT_FOUND",
   "errorCode":"40000",
   
"errorMessage":"USER by token=WUxrTG9jN3Z1OWloNkpLZ3NuQmlIZz0 doesn't exist"
}
   

Ошибки

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

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

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

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

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