Отчет по заказам
Требуется авторизация.
GET /v1.0/reports/orders
Опциональные параметры запроса:
- sortby – сортировка заказов.
Возможные значения:- number – сортировка по номеру заказа;
- submitdate – сортировка по дате подтверждения заказа;
- customer – сортировка по покупателю, указанному в заказе;
- orderstatus – сортировка по статусу заказа;
- shipmentdate – сортировка по дате отгрузки заказа;
- softwarelicense - сортировка по типу заказанной лицензии:
- 0 – программная;
- 1 – аппаратная.
По умолчанию выполняется сортировка по номеру.
- direction – направление сортировки:
- asc – сортировка от меньшего к большему;
- desc – сортировка от большего к меньшему.
- limit – максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100;
- offset – смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
- from – в отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет больше, чем дата, указанная в этом параметре (в формате unix time);
- to – в отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет меньше, чем дата, указанная в этом параметре (в формате unix time);
- products – список имен продуктов через запятую, заказы которых попадут в отчет;
- customers – список ID покупателей через запятую, чьи заказы попадут в отчет;
- istrial – флаг для заказов на пробные лицензии.
Если флаг не задан, то учитываются все заказы: на пробные и обычные лицензии.
Если значение флага false, то в отчете будут только заказы на обычные лицензии.
Если значение флага true, то в отчете будут только заказы на пробные лицензии.
Возвращает массив orders, каждый JSON-объект которого включает поля заказа, массив products, может включать поле customer (если есть).
Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).
Пример результата запроса:
{
"orders": [
{
"_id": 14,
"date": 1562588170,
"description": "",
"ishardwarelicense": false,
"number": 1,
"customer": {
"_id": 10,
"companyname": "test",
"email": "br@fff.ru",
"lastname": "Smith",
"name": "Dan"
},
"products": [
{
"_id": 10,
"modification": 0,
"name": "runcounter_1",
"productnumber": 1,
"status": 1
},
{
"_id": 11,
"modification": 0,
"name": "runcounter2",
"productnumber": 2,
"status": 1
}
],
"shipmentdate": 1562588192,
"status": 4,
"submitdate": 1562588192,
"type": 0
},
{
"_id": 17,
"date": 1562590022,
"description": "",
"ishardwarelicense": false,
"number": 2,
"products": [
{
"_id": 10,
"modification": 0,
"name": "test1",
"productnumber": 1,
"status": 1
},
{
"_id": 11,
"modification": 0,
"name": "test2",
"productnumber": 2,
"status": 1
}
],
"shipmentdate": 1562591031,
"status": 4,
"submitdate": 1562591031,
"type": 0
}
],
"xcount": 741
}
Отчет по продуктам
Требуется авторизация.
GET /v1.0/reports/products
Опциональные параметры запроса:
- sortby – сортировка продуктов:
- number – сортировка по номеру продукта;
- name – сортировка по названию продукта;
- total_licenses_count – сортировка по полю total_licenses_count;
- activated_licenses_count – сортировка по полю activated_licenses_count;
- applied_updates_count – сортировка по полю applied_updates_count.
- direction – направление сортировки:
- asc – сортировка от меньшего к большему;
- desc – сортировка от большего к меньшему.
- limit – максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100;
- offset – смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
- from – нижняя граница по времени, с учетом которой рассчитываются параметры total_licenses_count, activated_licenses_count, applied_updates_count (в формате unix time);
- to – верхняя граница по времени, с учетом которой рассчитываются параметры total_licenses_count, activated_licenses_count, applied_updates_count (в формате unix time);
- products – список имен продуктов через запятую, которые попадут в отчет;
- customers – список ID покупателей через запятую, чьи продукты попадут в отчет.
Возвращает массив products. Некоторые поля объектов массива:
- total_licenses_count – общее количество заказанных аппаратных ключей и серийных номеров с данным продуктов;
- activated_licenses_count – количество прошитых аппаратных ключей и активированных серийных номеров с данным продуктов;
- applied_updates_count – количество примененных обновлений данного продукта.
Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).
Пример результата запроса:
{
"products": [
{
"_id": 91031,
"activated_licenses_count": 1,
"applied_updates_count": 0,
"modification": 0,
"name": "test1",
"productnumber": 45495,
"status": 1,
"total_licenses_count": 3
},
{
"_id": 91034,
"activated_licenses_count": 5,
"applied_updates_count": 0,
"modification": 0,
"name": "trial_net",
"productnumber": 45496,
"status": 1,
"total_licenses_count": 17
}
],
"xcount": 179
}
Отчет по истекающим лицензиям
Требуется авторизация.
GET /v1.0/reports/expiring_licenses
Обязательный параметр запроса – days (максимальное количество дней до истечения лицензии).
Опциональные параметры запроса:
- sortby – сортировка:
- expirationdate – сортировка по минимальной дате истечения лицензии;
- customer – сортировка по покупателю, указанному в заказе;
- ordernumber – сортировка по номеру заказа;
- shipmentdate – сортировка по дате отгрузки заказа.
Даже если параметр sortby не указан, то по умолчанию всегда применяется сортировка по минимальной дате истечения лицензии (expirationdate).
- direction – направление сортировки:
- asc – сортировка от меньшего к большему;
- desc – сортировка от большего к меньшему.
Если параметр не указан, то по умолчанию используется сортировка asc.
- limit – максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100;
- offset – смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
- products – список имен продуктов через запятую, лицензии на которые попадут в отчет;
- customers – список имен покупателей через запятую, чьи лицензии попадут в отчет;
- istrial – флаг для пробных лицензий.
Если флаг не задан, то учитываются все лицензии: пробные и обычные.
Если значение флага false, то в отчете будут только обычные лицензии.
Если значение флага true, то в отчете будут только пробные лицензии.
Возвращает массив expiring_serial_and_dongles, каждый JSON-объект которого включает поля серийного номера или аппаратного ключа, массив products с продуктами, компонентами и лицензионными ограничениями, поле order с информацией о заказе, поле min_expirationdate c датой (в формате unix time) истечения времени действия компонента, которое истечет раньше всех остальных в лицензии, поле min_seconds_to_expiration с количеством секунд, оставшихся до истечения времени действия компонента, которое истечет раньше всех остальных в лицензии. Элементы массива expiring_serial_and_dongles (серийные номера и аппаратные ключи) отсортированы в порядке возрастания поля min_expirationdate.
Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).
Пример результата запроса:
{
"expiring_serials_and_dongles": [
{
"_id": 135,
"dongleid": -1319462696,
"first_activation_date": 1565942431,
"min_expirationdate": 1723106641,
"min_seconds_to_expiration": 86400,
"order": {
"_id": 116,
"date": 1565941591,
"description": "",
"ishardwarelicense": false,
"istrial": false,
"licenses_activated": 1,
"number": 17,
"shipmentdate": 1565941610,
"status": 4,
"submitdate": 1565941610,
"type": 0
},
"products": [
{
"_id": 28,
"modification": 0,
"name": "one_feature",
"productnumber": 16,
"status": 1
}
]
},
{
"_id": 138,
"dongleid": -37636497,
"first_activation_date": 1565942916,
"min_expirationdate": 1723106641,
"min_seconds_to_expiration": 86400,
"order": {
"_id": 117,
"date": 1565942880,
"description": "",
"ishardwarelicense": false,
"istrial": false,
"licenses_activated": 1,
"number": 18,
"shipmentdate": 1565942888,
"status": 4,
"submitdate": 1565942888,
"type": 0
},
"products": [
{
"_id": 28,
"modification": 0,
"name": "one_feature",
"productnumber": 16,
"status": 1
}
]
}
],
"xcount": 34
}
Отчет по клиентам
Эквивалентен Отчету по заказам при указании имени клиента в параметре запроса customers.
Получение списка лицензионных ключей (аппаратных и программных)
Требуется авторизация.
GET /v1.0/reports/licensing_keys
Опциональные параметры запроса:
- sortby – сортировка заказов:
- dongleid – сортировка ID ключей;
- activationdate – сортировка по дате первой активации (для серийных номеров)/дате первой прошивки (для аппаратных ключей);
- model – сортировка по модели ключа;
- customer – сортировка по покупателю, указанному в заказе;
- ordernumber – сортировка по номеру заказа;
- shipmentdate – сортировка по дате отгрузки заказа.
По умолчанию выполняется сортировка по dongleid.
- direction – направление сортировки:
- asc – сортировка от меньшего к большему;
- desc – сортировка от большего к меньшему.
- limit – максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100;
- offset – смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
- from – в отчет будут попадать только ключ, у которых дата первой активации/прошивки будет больше, чем дата, указанная в этом параметре (в формате unix time);
- to – в отчет будут попадать только заказы, у которых дата первой активации/прошивки будет меньше, чем дата, указанная в этом параметре (в формате unix time);
- customers – список ID покупателей через запятую, чьи ключи попадут в отчет.
Возвращает массив licensing_keys.
Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).
Пример результата запроса:
{
"licensing_keys": [
{
"customer": {
"_id": 20076,
"companyname": "",
"email": "jon@smith.uk",
"lastname": "smith",
"name": "jon"
},
"dongleid": 1053062490,
"first_activation_date": 1623068847,
"model": 3,
"order": {
"_id": 21539,
"date": 1621501686,
"description": "",
"ishardwarelicense": true,
"number": 309,
"shipmentdate": 1623068847,
"status": 4,
"submitdate": 1621501698,
"type": 0
}
},
{
"customer": {
"_id": 20076,
"companyname": "",
"email": "jack@london.uk",
"lastname": "london",
"name": "jack"
},
"dongleid": 1052080995,
"first_activation_date": 0,
"model": 2,
"order": {
"_id": 21536,
"date": 1621336814,
"description": "",
"ishardwarelicense": true,
"number": 307,
"status": 1,
"submitdate": 1621336827,
"type": 0
}
}
],
"xcount": 10
}
Запросы для Dashboard
График создания + выполнения заказов. Временная шкала показывает количество заказов.
Требуется авторизация.
GET /v1.0/reports/orders_completion_graph
Обязательные параметры запроса:
- period – шаг по оси времени:
- day;
- week;
- month;
- year.
- from – в отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет больше, чем дата, указанная в этом параметре (в формате unix time);
- to – в отчет будут попадать только заказы, у которых дата подтверждения (submitdate) будет меньше, чем дата, указанная в этом параметре (в формате unix time);
- products – список имен продуктов через запятую, заказы которых попадут в отчет;
- customers – список ID покупателей через запятую, чьи заказы попадут в отчет;
- istrial – флаг для заказов на пробные лицензии.
Если флаг не задан, то учитываются все заказы: на пробные и обычные лицензии.
Если значение флага false, то в отчете будут только заказы на обычные лицензии.
Если значение флага true, то в отчете будут только заказы на пробные лицензии; - integrated_data – флаг, который определяет каким образом будут формироваться данные для графика.
Если значение флага true, то график будет накопительным (данные из предыдущих периодов будут складываться с данными по текущему периоду). По умолчанию значение параметра равно false.
Период анализа начинается со дня/недели/месяца/года (в зависимости от выбранного параметром period шага) самого первого подтвержденного заказа по настоящее время.
Возвращает массив 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
}
]
}
===============================================================================
5 заказов с лицензиями, которые скоро истекут (если есть)
и
5 заказов с триалками, которые скоро истекут (если есть)
Эти данные можно получить используя запрос для формирования Отчета по истекающим лицензиям при указании в нем параметра limit равным 5 и соответствующего значения параметра istrial (true или false).
===============================================================================
5 наиболее активных клиентов за месяц (если есть)
Авторизация требуется.
GET /v1.0/reports/most_active_customers
Обязательные параметры запроса:
- days - количество последних дней за которые нужен отчет
Опциональные параметры запроса:
- limit - максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100.
- offset - смещение, показывающее с какого порядкого номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
Возвращает массив customers, каждый JSON-объект которого содержит поля клиента, а также поле orders_amount, которое содержит колиство подтвержденных заказов для этого клиента за последние days дней. Объекты в массиве отсортированы в порядке убывания значения orders_amount.
Пример результата запроса:
{
"customers": [
{
"_id": 20076,
"companyname": "",
"email": "sidoroff@mail.ru",
"lastname": "sidorov",
"name": "petay",
"orders_amount": 2
},
{
"_id": 20088,
"companyname": "eeeee",
"email": "sss@sss.ru",
"lastname": "111",
"name": "11",
"orders_amount": 2
},
{
"_id": 10058,
"companyname": "",
"email": "ba@go.ru",
"lastname": "Ivanov",
"name": "Ivan",
"orders_amount": 1
}
]
}
Отчет по потреблению ключей и лицензий
Авторизация требуется.
GET /v1.0/reports/licenses_consumption
Опциональные параметры запроса:
- from - в отчет будут учтены только заказы, у которых дата подтверждения (submitdate) будет больше, чем дата, указанная в этом параметре (в формате unix time);
- to - в отчет будут учтены только заказы, у которых дата подтверждения (submitdate) будет меньше, чем дата, указанная в этом параметре (в формате unix time).
Возвращает объект licenses_consumption, который включает следующие поля:
- consumed_dl_local_licenses - количество списанных с баланса локальных DL лицензий;
- consumed_dl_net_licenses- количество списанных с баланса сетевых DL лицензий;
- consumed_dl_transaction- количество списанных с баланса операций для DL лицензий;
- consumed_dl_trial_licenses- количество списанных с баланса пробных DL лицензий;
- consumed_dongle_net_licenses - количество списанных с баланса сетевых лицензий для аппаратных ключей;
- consumed_dongle_transaction - количество списанных с баланса операций для аппаратных ключей;;
- consumed_vtc_balance - количество списанного баланса для аппаратных ключей с виртуальным таймеров;
- firsttime_burned_sign_dongles_amount - количество впервые прошитых за период или за все время аппаратных ключей Guardant Sign;
- firsttime_burned_time_dongles_amount- количество впервые прошитых аппаратных ключей Guardant Time;
- total_dongles_amount - количество заказанных аппаратных ключей;
- total_serialnumbers_amount - количество заказанных серийных номеров;
- burned_dongles_amount - количество прошитых аппаратных ключей;
- activated_serialnumbers_amount - количество активированных серийных номеров.
Пример результата запроса:
"licenses_consumption": {
"consumed_dl_local_licenses": 77,
"consumed_dl_net_licenses": 1969,
"consumed_dl_transaction": 104,
"consumed_dl_trial_licenses": 5,
"consumed_dongle_net_licenses": 22,
"consumed_dongle_transaction": 16,
"consumed_vtc_balance": 2,
"firsttime_burned_sign_dongles_amount": 12,
"firsttime_burned_time_dongles_amount": 4,
"total_dongles_amount": 117,
"total_serialnumbers_amount": 337,
"activated_serialnumbers_amount": 81,
"burned_dongles_amount": 21
}
}
Продукты, которые не участвовали в заказе более N дней
Авторизация требуется.
GET /v1.0/reports/rare_products
Обязательные параметры запроса:
- days - количество дней N.
Опциональные параметры запроса:
- sortby - сортировка продуктов. Возможные значения: number - сортировка по номеру продукта (главный приоритет) и номеру модификации (второстепенная сортировка), name - сортировка по названию продукта. По умолчанию выполняется сортировка по номеру и модификации.
- direction - направление сортировки. Возможные значения: asc - сортировка от меньшего к большему, desc - сортировка от большего к меньшему;
- limit - максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100.
- offset - смещение, показывающее с какого порядкого номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
Возвращает массив rare_products.
Пример результата запроса:
{
"rare_products": [
{
"_id": 10,
"modification": 0,
"name": "runcounter_1",
"productnumber": 1,
"status": 1
},
{
"_id": 11,
"modification": 0,
"name": "runcounter2",
"productnumber": 2,
"status": 1
},
{
"_id": 28,
"modification": 0,
"name": "one_feature",
"productnumber": 16,
"status": 1
}
]
}
Память, которая не участвовала в заказе более N дней
Авторизация требуется.
GET /v1.0/reports/rare_memory
Обязательные параметры запроса:
- days - количество дней N.
Опциональные параметры запроса:
- sortby - сортировка ячеек памяти. Возможные значения: name - сортировка по названию ячейки (по умолчанию), aliasid - сортировка по ID ячейки.
- direction - направление сортировки. Возможные значения: asc - сортировка от меньшего к большему, desc - сортировка от большего к меньшему;
- limit - максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100.
- offset - смещение, показывающее с какого порядкого номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
Возвращает массив rare_memory.
Пример результата запроса:
{
"rare_memory": [
{
"_id": 0,
"aliasid": 117,
"name": "2b"
},
{
"_id": 0,
"aliasid": 117,
"name": "4bytes"
},
{
"_id": 0,
"aliasid": 104,
"name": "delete_mem"
},
{
"_id": 0,
"aliasid": 500,
"name": "item500"
}
]
}
Компоненты, которые не участвовали в заказе более N дней
Авторизация требуется.
GET /v1.0/reports/rare_features
Обязательные параметры запроса:
- days - количество дней N.
Опциональные параметры запроса:
- sortby - сортировка ячеек памяти. Возможные значения: number - сортировка по номеру компонента (по умолчанию), name - сортировка по названию компонента.
- direction - направление сортировки. Возможные значения: asc - сортировка от меньшего к большему, desc - сортировка от большего к меньшему;
- limit - максимальное количество записей, которые можно получить. Возможные значения: от 1 до 100 включительно. По умолчанию (если не задано в запросе) limit равен 100.
- offset - смещение, показывающее с какого порядкого номера записи (с учетом выбранной сортировки) необходимо получить limit записей. Записи нумеруются с 0;
Возвращает массив rare_features.
Пример результата запроса:
{
"rare_features": [
{
"_id": 36,
"featurenumber": 16,
"name": "lifetime_feature"
},
{
"_id": 32,
"featurenumber": 154,
"name": "основной модуль"
},
{
"_id": 42,
"featurenumber": 261,
"name": "test_time1"
}
]
}
