Категории KPI / KPIs

Эти KPI связаны с категорией KPI, позволяют вам легко перечислять и управлять KPI в рамках конкретной категории.

Объект KPI

Объект имеет следующие свойства:

Название Тип Только для чтения Обязательный Макс. длина Комментарии
id integer да нет   Автоматически генерируется для KPI
category_id integer да нет   Идентификатор категории к которой принадлежит KPI
image_id integer нет да   Идентификатор иконки, присвоенной KPI
format_id integer нет да   Идентификатор единицы измерения, присвоенной KPI
frequency character нет да 1 Идентификатор частоты ввода данных для KPI. Это поле чувствительно к регистру и должно быть в верхнем регистре.
name string нет да 100 Название KPI
description string нет нет 150 Описание KPI
target decimal нет нет   Цель по умолчанию для KPI. Если значение пустое или равно null, то KPI не будет иметь цели
direction character нет да 1 Направление значения чувствительно к регистру и могут быть установлены только значения U(вверх), D(вниз) и N(никакое)
aggregate string нет да 3 Агрегатная функция определяет, как рассчитать KPI, и может принимать значения AVG (Среднее) или SUM (Общая сумма).
disable boolean нет да   В активные KPI можно ввести данные, если они не введена. Неактивные KPI предназначены только для отображения
calculated boolean да нет   Внести изменения в рассчитываемые KPI через API нельзя. KPI должны быть добавлены или изменены в интерфейсе.

Пример JSON

{
  "id":                 111,
  "category_id":        222,
  "icon_id":            1,
  "unit_id":            11,
  "frequency_id":       "M",
  "name":               "Number of Sales",
  "description":        "Kpi description",
  "target_default":     null,
  "value_direction":    "N",
  "aggregate_function": "SUM",
  "is_active":          true,
  "calculated":      false,
}

Пример XML

<KPI xmlns="http://schemas.datacontract.org/2004/07/Waytobi.App.Api.Models" 
     xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <id>111</id>
  <category_id>222</category_id>
  <icon_id>1</icon_id>
  <unit_id>11</unit_id>
  <frequency_id>M</frequency_id>
  <name>Number of Sales</name>
  <description>Kpi description</description>
  <target_default>null</target_default>
  <value_direction>N</value_direction>
  <aggregate_function>SUM</aggregate_function>
  <is_active>true</is_active>
  <calculated>false</is_calculated>
</KPI>

 

Получить все KPI из категории

GET /api/kpicategories/{category_id}/kpis

Используя curl

curl https://app.waytobi.com/api/kpicategories/{category_id}/kpis
  -v -u {token}

Пример ответа

Status: 200 OK
[
  {
   "id": 111,
   "category_id": 222,
   "icon_id": 1,
   "unit_id": 11,
   "frequency_id": "M",
   "name": "Number of Sales",
   "description": "Kpi description",
   "target_default": null,
   "value_direction": "N",
   "aggregate_function": "SUM",
   "is_active": true,
   "calculated": false,
  },
  {
   "id": 112,
   "category_id": 223,
   "icon_id": 4,
   "unit_id": 2,
   "frequency_id": "D",
   "name": "Calls",
   "description": "Calls kpi description",
   "target_default": null,
   "value_direction": "N",
   "aggregate_function": "SUM",
   "is_active": true,
   "calculated": false,
  }
]

 

Получить KPI из категории

GET /api/kpicategories/{category_id}/kpis/{id}

Используя curl

curl https://app.waytobi.com/api/kpicategories/{category_id}/kpis/{id}
  -v -u {token}

Пример ответа

Status: 200 OK
{
  "id": 111,
  "category_id": 222,
  "icon_id": 1,
  "unit_id": 11,
  "frequency_id": "M",
  "name": "Number of Sales",
  "description": "Kpi description",
  "target_default": null,
  "value_direction": "N",
  "aggregate_function": "SUM",
  "is_active": true,
  "calculated": false,
}

 

Добавить KPI в категорию

POST /api/kpicategories/{category_id}/kpis

Используя curl

curl https://app.waytobi.com/api/kpicategories/{category_id}/kpis
  -H "Content-Type: application/json" 
  -d '{"icon_id":1, "unit_id":11, "frequency_id":"M", "name":"Number of Sales", 
       "description":"New description", "target_default":100, "value_direction":"N",
       "is_active":true}'
  -v -u {token} -X POST

Пример ответа

Status: 201 Created
Location: https://app.waytobi.com/api/kpicategories/{category_id}/kpis/{id}
{
  "id": 111,
  "category_id": 222,
  "icon_id": 1,
  "unit_id": 11,
  "frequency_id": "M",
  "name": "Number of Sales",
  "description": "New description",
  "target_default": 100,
  "value_direction": "N",
  "aggregate_function": "SUM",
  "is_active": true,
  "calculated": false,
}

 

Обновить KPI в категории

PUT /api/kpicategories/{category_id}/kpis/{id}

Используя curl

curl https://app.waytobi.com/api/kpicategories/{category_id}/kpis/{id}
  -H "Content-Type: application/json" 
  -d '{"icon_id":1, "unit_id":11, "frequency_id":"M", "name":"Number of Sales", 
       "description":"New description", "target_default":100, "value_direction":"N",
       "is_active":true}'
  -v -u {token} -X PUT

Пример ответа

Status: 200 OK
{
  "id": 111,
  "category_id": 222,
  "icon_id": 1,
  "unit_id": 11,
  "frequency_id": "M",
  "name": "Number of Sales",
  "description": "New description",
  "target_default": 100,
  "value_direction": "N",
  "aggregate_function": "SUM",
  "is_active": true,
  "calculated": false,
}

 

Удалить KPI в категории

DELETE /api/kpicategories/{category_id}/kpis/{id}

Используя curl

curl https://app.waytobi.com/api/kpicategories/{category_id}/kpis/{id}
  -v -u {token}

Пример ответа

Status: 200 OK

Не можете найти ответ?

Ищете что-то конкретное? Попробуйте посмотреть различные папки и категории соответсвующие вашему запросу на предмет необходимой информации.

Связаться с нами