REST API Содержит запросы, для создание Dashboard:

График создания и выполнения заказов

Метод возвращает данные для графика создания и выполнения заказов. Временная шкала показывает количество заказов.

Период анализа начинается со дня/недели/месяца/года (в зависимости от параметра period) самого первого подтвержденного заказа по настоящее время.

Адрес/v1.0/reports/orders_completion_graph
ТипGET
LoginТребуется 

Входные параметры

ПараметрОбязательностьОписаниеВозможные значения
period ОбязателенШаг по оси времени
  • day;
  • week;
  • month;
  • year

from

Обязателен

В ответ будут попадать только заказы, у которых дата подтверждения (submitdate) будет больше, чем дата, указанная в этом параметре (в формате Unix time)



to

Обязателен

В ответ будут попадать только заказы, у которых дата подтверждения (submitdate) будет меньше, чем дата, указанная в этом параметре (в формате Unix time)


products

Обязателен

Список имен продуктов через запятую, заказы которых попадут в ответ


customers

Обязателен

Список ID покупателей через запятую, чьи заказы попадут в ответ


istrial

Опционален

Фильтрация заказов на пробные лицензии.

По умолчанию в запросе возвращаются все заказы

  • false — вернутся только заказы на обычные лицензии;
  • true — вернутся только заказы на пробные лицензии
integrated_data 

Обязателен

Флаг, который определяет каким образом будут формироваться данные для графика.

По умолчанию — false

  • true — график будет накопительным (данные из предыдущих периодов будут складываться с данными по текущему периоду);
  • false график будет не накопительным
Пример запроса
https://station.guardant.ru/v1.0/reports/orders_completion_graph?period=day&from=1577836799&to=1640995200

Ответ

Возвращает массив graph_data, каждый JSON-объект которого включает следующие поля:

  • timepoint — дата в формате unix time;
  • submitted_hardware_orders_amount — количество подтвержденных заказов на аппаратные ключи;
  • submitted_software_orders_amount — количество подтвержденных заказов на программные лицензии;
  • completed_hardware_orders_amount — количество заказов на аппаратные ключи, у которых указанное в заказе количество аппаратных ключей совпадает с количеством прошитых аппаратных ключей;
  • completed_software_orders_amount — количество заказов на программные лицензии, у которых указанное в заказе количество серийных номеров совпадает с количеством активированных серийных номеров;
  • burned_dongles_amount — количество прошитых аппаратных ключей;
  • activated_serials_amount — количество активированных серийных номеров.
Пример результата запроса
{
    "graph_data": [
        {
            "activated_serials_amount": 1,
            "burned_dongles_amount": 0,
            "completed_hardware_orders_amount": 0,
            "completed_software_orders_amount": 1,
            "submitted_hardware_orders_amount": 14,
            "submitted_software_orders_amount": 45,
            "timepoint": 1577836799
        },
        {
            "activated_serials_amount": 7,
            "burned_dongles_amount": 1,
            "completed_hardware_orders_amount": 0,
            "completed_software_orders_amount": 6,
            "submitted_hardware_orders_amount": 56,
            "submitted_software_orders_amount": 69,
            "timepoint": 1609459199
        },
        {
            "activated_serials_amount": 47,
            "burned_dongles_amount": 15,
            "completed_hardware_orders_amount": 25,
            "completed_software_orders_amount": 9,
            "submitted_hardware_orders_amount": 191,
            "submitted_software_orders_amount": 131,
            "timepoint": 1640995199
        }
    ]
}


Поиск заказов с лицензиями, которые скоро истекут

Эти данные можно получить используя запрос для формирования Отчета по истекающим лицензиям при указании в нем параметра limit равным 5 и соответствующего значения параметра istrial (true или false).

Поиск наиболее активных клиентов

Метод возвращает список самых активных клиентов за переданное количество дней.

Адрес/v1.0/reports/most_active_customers
ТипGET
LoginТребуется 

Входные параметры

ПараметрОбязательностьОписаниеВозможные значения
days ОбязателенКоличество последних дней, за которые нужен отчет 

limit

Опционален

Максимальное количество записей, которые можно получить.

По умолчанию равен 100

От 1 до 100 включительно

offset

Опционален

Смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей.

Записи нумеруются с 0


Пример запроса
https://station.guardant.ru/v1.0/reports/most_active_customers?days=100&limit=2&offset=10

Ответ

Возвращает массив customers, каждый JSON-объект которого содержит поля клиента, а также поле orders_amount, которое содержит количество подтвержденных заказов для этого клиента за последние days дней. Объекты в массиве отсортированы в порядке убывания значения orders_amount.

Пример результата запроса
{
    "customers": [
        {
            "_id": 20076,
            "companyname": "Johncompany",
            "email": "John@mycompany.com",
            "lastname": "Doe",
            "name": "John",
            "orders_amount": 30
        },
        {
            "_id": 20088,
            "companyname": "Janecompany",
            "email": "Jane@company.com",
            "lastname": "Doe",
            "name": "Jane",
            "orders_amount": 2
        }
    ]
}


  • No labels