Метод возвращает отчет по продуктам.

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

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

ПараметрОбязательностьОписаниеВозможные значения
sortby Опционален

Сортировка продуктов.

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

  • number — сортировка по номеру продукта;
  • name — сортировка по названию продукта;
  • total_licenses_count — сортировка по полю total_licenses_count;
  • activated_licenses_count — сортировка по полю activated_licenses_count; 
  • applied_updates_count — сортировка по полю applied_updates_count

direction

Опционален

Направление сортировки.

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

  • asc — сортировка от меньшего к большему;
  • desc — сортировка от большего к меньшему

limit

Опционален

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

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

От 1 до 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 покупателей через запятую, чьи продукты попадут в отчет


Пример запроса
https://station.guardant.ru/v1.0/reports/products?sortby=number&direction=desc&limit=3&offset=10&from=1586428828&to=1775731228&istrial=false

Ответ

Возвращает массив products. Некоторые поля объектов массива:

  • total_licenses_count — общее количество заказанных аппаратных ключей и серийных номеров с данным продуктов;
  • activated_licenses_count — количество прошитых аппаратных ключей и активированных серийных номеров с данным продуктов;
  • applied_updates_count — количество примененных обновлений данного продукта.

Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).

Пример результата запроса 
{
    "products": [
        {
            "_id": 20991,
            "activated_licenses_count": 2,
            "applied_updates_count": 0,
            "modification": 0,
            "name": "rtadmin",
            "productnumber": 27,
            "status": 1,
            "total_licenses_count": 3
        },
        {
            "_id": 20469,
            "activated_licenses_count": 3,
            "applied_updates_count": 1,
            "modification": 0,
            "name": "Clock",
            "productnumber": 26,
            "status": 1,
            "total_licenses_count": 3
        },
        {
            "_id": 20032,
            "activated_licenses_count": 3,
            "applied_updates_count": 3,
            "modification": 0,
            "name": "feature HDGraph и Clock",
            "productnumber": 25,
            "status": 1,
            "total_licenses_count": 3
        }
    ],
    "xcount": 38
}


  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru