Skip to main content

API

Список датасетів / bi-dataset-list​

Отримання списку всіх датасетів по BI.

/api-user/bi-dataset-list

Відповідь на запит

Details
[
  {
    "dataset_id": "3177192759895262487", // Id
    "name": "test", // Назва
    "table_name": "data_user.b87dde72dd78736d74af82d8", // Таблиця
    "files": null,
    "public": true, // Публічно
    "user_only": false, // Обмеження по користувачу
    "dataset_access": [ // Доступи
      {
        "access_id": "3260615123944867644",
        "user_id": "1", // Користувач
        "dashboard_id": null, 
        "enabled": true, // Включено
        "dataset_id": "3177192759895262487" // Датасет
      }
    ]
  }
]

Інформація про датасет / bi-dataset​

Отримання даних по BI про датасет.

id - Ідентифікатор датасету

Приклад запиту

/api-user/bi-dataset/3177192759895262487

Відповідь

Details
{
  "dataset": {
    "dataset_id": "3177192759895262487",
    "name": "test",
    "table_name": "data_user.b87dde72dd78736d74af82d8",
    "public": true,
    "user_only": false,
    "dataset_access": [
      {
        "access_id": "3260615123944867644",
        "user_id": "1",
        "dashboard_id": null,
        "enabled": true,
        "dataset_id": "3177192759895262487"
      }
    ]
  },
  "meta": {
    "meta": {
      "name": null,
      "table": "data_user.b87dde72dd78736d74af82d8",
      "pk": "b87dde72dd78736d74af82d8_id",
      "view": "data_user.b87dde72dd78736d74af82d8",
      "count": 0,
      "tableCode": 2
    },
    "access": true,
    "pt": { },
    "geom": {
      "attr": "geom"
    },
    "columns": [
      {
        "name": "b87dde72dd78736d74af82d8_id",
        "type": "text",
        "filterCode": 30
      },
      {
        "name": "col_0",
        "type": "text",
        "title": "Country",
        "filterCode": 31
      },
      {
        "name": "col_1",
        "type": "text",
        "title": "Count",
        "filterCode": 32
      }
    ]
  },
  "rows": [
    {
      "e2a9b7be0e84244c2ef99_id": "3186480258320696558",
      "geom": null,
      "col_0": "Безпека",
      "col_1": "2023 рік",
      "col_2": "кількість злочинів ",
      "col_3": "615",
      "cdate": "2023-09-07 12:14:29.357131",
      "editor_date": null,
      "uid": null,
      "editor_id": null,
      "files": null
    },
    {
      "e2a9b7be0e84244c2ef99_id": "3186480258320696559",
      "geom": null,
      "col_0": "Безпека",
      "col_1": "2023 рік",
      "col_2": "кількість розкритих злочинів",
      "col_3": "394",
      "cdate": "2023-09-07 12:14:29.357131",
      "editor_date": null,
      "uid": null,
      "editor_id": null,
      "files": null
    }
  ]
}

Інформація про віджет / vs.bi.widget​

Надсилає налаштування та дані необхідні для відображення віджетів на дашборді.

/api-user/vs.bi.widget?id=[id]&widget=[widget]

Параметри запиту​

ПараметрОпис
typeТип візуалізації, наприклад, стовпчик, таблиця, бублик, кругова діаграма.
idІдентифікатор Dashboard, унікальний для кожної панелі.
widgetІдентифікатор віджету, використовується для визначення конкретного віджету на Dashboard.
datasetІдентифікатор віджету, використовується для визначення конкретного віджету на Dashboard.
filterПараметр для фільтрації даних, дозволяє вибирати конкретні дані згідно заданих критеріїв.
tokenАутентифікаційний токен для верифікації доступу користувача.
tableНазва таблиці, з якої будуть витягуватися дані.
limitОбмеження на кількість рядків, які будуть повернуті у запиті.
orderПорядок сортування даних у запиті.
sortСортування даних, наприклад, за зростанням або спаданням.

Приклад запиту​

/api-user/vs.bi.widget?id=3246798247087309903&widget=chart_1242

Відповідь на запит

Details
{
  "time": {
    "query": 0,
    "data": 0,
    "total": 0
  },
  "dimensions": [
    "count"
  ],
  "widget": {
    "text": "pie-5874",
    "type": "pie",
    "options": {
      "order": 6,
      "width": 300,
      "height": 300
    }
  },
  "cls": null,
  "source": [
    {
      "count": "18"
    }
  ],
  "meta": {
    "columns": [
      {
        "name": "ip_id",
        "type": "text",
        "text": "ID Інвестиційного проекту",
        "percent": "100"
      },
      {
        "name": "ip_number",
        "type": "text",
        "text": "Номер проекту",
        "percent": "100"
      },
      {
        "name": "ip_name",
        "type": "text",
        "text": "Назва проекту",
        "percent": "94"
      }
    ],
    "meta": {
      "name": "Інвестиційний проект",
      "table": "inv_map.im_inv_project",
      "pk": "ip_id",
      "view": "inv_map.im_inv_project",
      "count": 18,
      "tableCode": "9"
    }
  }
}