dashboards.php¶

API для управления дашбордами и отчетами: добавление, удаление и управление составом отчетов в рамках конкретного дашборда

Методы API¶

Метод	Действие	Описание
`add_report`	добавление отчета	Добавляет новый отчет в существующий дашборд с указанием типа сортировки.
`delete_report`	удаление отчета	Удаляет конкретный отчет из дашборда.
`delete_report_all`	удаление всех отчетов	Удаляет все отчеты из указанного дашборда.

dashboards/add_report¶

Добавляет новый отчет в существующий дашборд с указанием типа сортировки.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add_report`
token	✅	string	Токен авторизации
id	❌	integer	ID дашборда
report_id	❌	integer	ID отчета для добавления
sort_order	❌	integer	Порядок сортировки отчетов. По умолчанию 0.

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

curl -s "https://invapi.hostkey.ru/dashboards.php" -X POST \
--data "action=add_report" \
--data "token=HOSTKEY_TOKEN" \
--data "id=45" \
--data "report_id=789" \
--data "sort_order=0"

Пример успешного ответа

{
"result": "OK",
"action": "add_report",
"data": {
"id": 123,
"dashboard_id": 45,
"report_id": 789,
"sort_order": 0,
"status": "active"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

dashboards/delete_report¶

Удаляет конкретный отчет из дашборда.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_report`
token	✅	string	Токен авторизации
id	❌	integer	ID дашборда
report_id	❌	integer	ID отчета для удаления

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

curl -s "https://invapi.hostkey.ru/dashboards.php" -X POST \
--data "action=delete_report" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "report_id=789"

Пример успешного ответа

{
"result": "OK",
"action": "delete_report",
"data": {
"status": "deleted",
"id": 789
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}

dashboards/delete_report_all¶

Удаляет все отчеты из указанного дашборда.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_report_all`
token	✅	string	Токен авторизации
id	❌	integer	ID дашборда для удаления всех отчетов

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

curl -s "https://invapi.hostkey.ru/dashboards.php" -X POST \
--data "action=delete_report_all" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "delete_report_all",
"data": {
"count": 5,
"status": "success"
}
}

Примеры ошибок

{
"code": -1,
"message": "Action is not recognized"
}