Получение статистики по звонкам

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

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

https://api.tracker.k50.ru/v2/call/list/

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

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

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

POST

https://api.tracker.k50.ru/v2/call/list/

{
"apiKey": "00000000-0000-0000-0000-000000000000",
"counter": "00000000000",
"dimensions":  ["dimensions1", ..., "dimensionsN"],
"filter": "startTime>2017-04-01 00:00:00;duration>=30",
"itemsPerPage": 1000,
"page": 1
} 

GET

https://api.tracker.k50.ru/v2/call/list/?apiKey=00000000-0000-0000-0000-000000000000&counter=00000000000&dimensions%5B0%5D=dimensions1&dimensions%5B1%5D=dimensionsN&filter=startTime%3E2017-04-01+00%3A00%3A00%3Bduration&itemsPerPage=1000&page=1

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

{
  "result":[
    {"dimention1":"value", ... , "dimentionN":"value"},
    {"dimention1":"value", ... , "dimentionN":"value"},
  ],
  "totalResults":"<TOTAL RESULTS ON ALL PAGES>",
  "nextLink":"<URL to next page results>"}
}

Формат ответа в случае ошибочного запроса:

{"error":<HTTP_RESPONSE_CODE>,"message":"<MESSAGE>"}

Пример:

{"error":400,"message":"Invalid filter"}

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

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

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

name operator expression

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

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

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

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

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

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

  • Недопустимые символы, такие как &, должны быть закодированы обычным способом.

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

Объединение фильтров

Фильтры можно объединять с помощью логических операторов ИЛИ и И.
В качестве оператора ИЛИ используется запятая (,). Этот оператор имеет приоритет над оператором И, и его НЕЛЬЗЯ использовать для объединения параметров и показателей в одном выражении.

countryCode%3D%3DRU,countryCode%3D%3DKZ

В качестве оператора И используется точка с запятой (;). Оператор ИЛИ имеет приоритет над оператором И, который МОЖНО использовать для объединения параметров и показателей в одном выражении.

startTime%3E2000-01-01 00:00:00;duration%3E5

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

Параметры Описание
callId id звонка
startTime Время начала звонка
stopTime Время окончания звонка
calledPhone Номер, на который был осуществлён звонок (виртуальный номер для коллтрекинга)
duration Длительность звонка, в секундах
sid Id сеанса, связанного со звонком
uuid Id пользователям
poolName Название пула
countCall Порядковый номер обращения пользователя
poolName Название пула
phoneName Название номера
isCallback Направление звонка:
  • true - обратный
  • false - прямой
callRecordUrl URL записи разговора
tags Список тегов для звонка
connectDuration Время ожидания вызова
status Статус звонка (success/failed)
destination Номер, на который был перенаправлен вызов
areaCode Код региона (для номера клиента)
countryCode Код страны (для номера клиента)
regionName Название региона (для номера клиента)
statusCode Код статуса звонка
callerPhone Номер клиента
isFirstInSeries Является ли вызов уникальным
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 счетчика, в котором был зафиксирован звонок

Получение статистики по звонкам в CSV

Также информацию по звонкам можно выгружать в CSV файл.
Необходимо изменить адрес для отправки запроса

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

https://api.tracker.k50.ru/v2/call/list/csv/

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

https://api.tracker.k50.ru/v2/call/list/csv/?apiKey=00000000-0000-0000-0000-000000000000&counter=00000000000&dimensions%5B0%5D=dimensions1&dimensions%5B1%5D=dimensionsN&filter=startTime%3E2017-04-01+00%3A00%3A00%3Bduration&itemsPerPage=1000&page=1

Пример выгрузки