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

Данный метод выгружает статистику по заказам из K50 Трекера по заданным параметрам.

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

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

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

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

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

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

POST

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

{
"apiKey": "00000000-0000-0000-0000-000000000000",
"counter": "00000000000",
"dimensions":  ["dimensions1", ..., "dimensionsN"],
"filter": "dateTime>2017-04-01",
"itemsPerPage": 1000,
"page": 1
}

GET

http://api.tracker.k50.ru/v2/order/list/?apiKey=00000000-0000-0000-0000-000000000000&counter=00000000000&dimensions%5B0%5D=dimensions1&dimensions%5B1%5D=dimensionsN&filter=dateTime%3E2017-04-01+00%3A00%3A00%3B&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
== Равно. Для параметра tags проверяет наличие тега %3D%3D
!= Не равно. Для параметра tags проверяет отсутствие тега !%3D
> Больше %3E
< Меньше %3C
>= Больше или равно %3E%3D
<= Меньше или равно %3C%3D
=@ Содержит подстроку %3D%40
!@ Не содержит подстроку !%40

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

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

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

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

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

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

dateTime%3E2000-01-01 00:00:00;margin%3E530

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

Параметр Описание
orderId Id заказа
dateTime Дата заказа
margin Прибыль заказа
revenue Доход заказа
sid Id сеанса, связанного с заказом
uuid Id пользователя
comment Комментарий к заказу
contactPerson Контактное лицо
email Email контактного лица
type Тип заказа (online - заказ с сайта, offline - заказ со звонка)
tags Список тегов для заказа
connectDuration Время ожидания вызова
state Статус заказа
callerPhone Номер телефона, привязанный к заказу
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 client 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

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

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

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

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

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

http://api.tracker.k50.ru/v2/order/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

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