Присоединяйтесь!
  1. Saby
  2. База знаний
  3. API
  4. API Управление персоналом
  5. Справочники
  6. Сотрудники
  7. KPI
  8. sabyKPI.Statistics

Получить KPI по API

Получить KPI по API

С помощью метода sabyKPI.Statistics можно получить данные о KPI.

Перед выполнением запроса аутентифицируйтесь в Saby.

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

Параметр
* — обязательный

Тип

Описание

Params

объект

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

 

filter

объект

фильтр данных

scheme

строка

внешний идентификатор схемы мотивации. По умолчанию — «Общее для компании»

month

строка
YYYY-mm-dd

укажите первое число нужного месяца. Значение по умолчанию — первое число текущего месяца

parent

строка

внешний идентификатор подразделения

KPI

массив строк

список внешних идентификаторов KPI

onlyPersons

логический

признак вывода только сотрудников плоским списком. Возможные значения: true, false

hideBlankLines

логический

признак скрытия пустых строк. Возможные значения: true, false

getBase

логический

признак отображения базы. Возможные значения: true, false

getRate

логический

признак отображения ставки. Возможные значения: true, false

getPlan

логический

признак отображения плана. Возможные значения: true, false

getPercent

логический

признак отображения процента выполнения плана. Возможные значения: true, false

getResult

логический

признак отображения общего процента выполнения KPI. Возможные значения: true, false

navigation

объект

навигация

 

page

число

страница — по умолчанию 0

pageSize

число

размер страницы — по умолчанию 50

Результат

Параметр

Тип

Описание

data

массив объектов

данные мотивации

 

name

строка

ФИО сотрудника или название подразделения

parent

строка

внешний идентификатор вышестоящего подразделения

person

строка

внешний идентификатор сотрудника

department

строка

внешний идентификатор подразделения

result

число

показатель выполнения всех KPI в процентах

KPI

массив объектов

список показателей

 

extId

строка

внешний идентификатор KPI

name

строка

название KPI

value

число

значение

base

число

база

rate

число

ставка

plan

число

план

percent

число

процент выполнения плана

result

число

показатель выполнения всех KPI в процентах

navigationResult

объект

результат навигации

 

more

логический

признак наличия данных. Возможные значения: true, false

results

объект

итоговые данные по всем KPI. Содержит те же поля, что и объекты в data

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

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.