Получение списка лидов

Данный метод позволяет получить список лидов из указанного счетчика с заранее заданными параметрами.

Адрес для отправки запроса

http://api.tracker.k50.ru/v2/leads/list/

Адрес для выкачки списка лидов в формате CSV

http://api.tracker.k50.ru/v2/leads/list/csv

Поддерживаемые методы: GET, POST
Для POST запросов, параметры в GET не учитываются (кроме параметра apiKey).

Авторизация

Авторизация происходит по ключу apiKey. Ключ может быть передан в GET, POST или в заголовке "apiKey"

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

POST

{
"apiKey": "00000000-0000-0000-0000-000000000000",
"counter": "00000000000"
"dimensions":  ["dimensions1", ..., "dimensionsN"],
"filter": "tags=tag1"
"itemsPerPage": 1000
"page": 1
}

GET

apiKey=00000000-0000-0000-0000-000000000000&counter=00000000000&dimensions%5B0%5D=dimensions1&dimensions%5B1%5D=dimensionsN&filter=tags%3Etag1%3Bduration&itemsPerPage=1000&page=1**

Параметры запроса

Параметры Описание Обязательный
apiKey Токен для авторизации. Подробнее да
counter id счетчика да
dimensions Имя параметра, значение которого будет выдано в результатах. Поддерживается множественность да
isShowInterActionChain Показать цепочку взаимодействия лида нет
filter Правила фильтрации результатов поиска. нет
page Порядковый номер страницы ответа. По умолчанию 1 нет
itemsPerPage Число результатов в ответе. От 1 до 1000. По-умолчанию 1000 нет

Список доступных измерений

Имя Описание
phone Номер клиента
leadCreateDate Дата создания лида
name Название подключения
source Источник
updatedAt Дата последнего обновления
status Статус
socialNetworkType Социальная сеть
leadSourceName Название lead source
leadSourcePageName Имя страницы
leadSourcePageId ID страницы
leadLogFormName Имя формы
leadLogFormId ID формы
tags Теги
referrer Реферер
entryPoint Страница входа
outPoint Страница выхода
userAgent UserAgent пользователя
ip IP адрес пользователя
utmSource Метка utm_source
utmMedium Метка utm_medium
utmTerm Метка utm_term
utmContent Метка utm_content
utmCampaign Метка utm_campaign
rDomain Домен реферера
rTerm Поисковый запрос
yClid Метка yclid
gClid Метка gclid
compositeSource Источник
compositeSourceType Тип трафика
compositeKeyword Ключевое слово
deviceType Тип устройства
deviceName Название устройства
platformDescription Операционная система
browser Браузер
browserVersion Версия браузера
analyticsClientId Google Analytics clien id
country Страна (на основе IP)
city Город (на основе IP)
region Регион (на основе IP)
district Округ (на основе IP)
label Параметр label
lDomain Домен страницы входа
metrikaClientId Yandex metrika client id
externalUserId Внешний id пользователя
customDimension1 Пользовательское измерение 1
customDimension2 Пользовательское измерение 2
customDimension3 Пользовательское измерение 3
customDimension4 Пользовательское измерение 4
customDimension5 Пользовательское измерение 5
callPage Страница звонка
transferCounterId ID счетчика, в котором был зафиксирован звонок

Фильтрация данных

Синтаксис фильтра

Для одиночного фильтра используется следующий формат:

name operator expression

name - имя измерения (список поддерживаемых измерений перечислен в таблице в "Список поддерживаемых измерений").

operator - оператор (см. таблицу "Список операторов" ниже).

expression - фильтруемое значение.

Список операторов

Имя Описание Форма в кодировке URL
== Равно %3D%3D
!= Не равно !%3D
> Больше %3E
< Меньше %3C
>= Больше или равно %3E%3D
<= Меньше или равно %3C%3D
=@ Содержит подстроку %3D%40
!@ Не содержит подстроку !%40

Выражения фильтра

  • Недопустимые символы, такие как &, должны быть закодированы обычным способом.
  • При использовании в выражениях точки с запятой, запятой и обратной косой черты перед ними необходимо ставить символ обратной косой черты ( \; \, \\ )

Формат ответа

{
  "result":[
    {"dimension1":"value", ... , "dimensionN":"value"},
    {"dimension1":"value", ... , "dimensionN":"value"},
  ],
  "totalResults":"<TOTAL RESULTS ON ALL PAGES>",
  "nextLink":"<URL to next page results>"}
}
Формат ответа в случае ошибочного запроса:
{"error":<HTTP_RESPONSE_CODE>,"message":"<MESSAGE>"}
Пример:
{"error":400,"message":"Invalid filter"}

Список возможных ошибок

Ошибка Описание
Invalid filter Ошибка в параметре filter
api.error.dimensions.unsupported Ошибка в параметре dimensions
api.error.itemsPerPage.min Неверно указано минимальное число результатов в ответе
api.error.itemsPerPage.max Неверно указано максимальное число результатов в ответе
api.error.counter.empty В счетчике отсутствуют лиды
Access Denied Доступ к счетчику не разрешен