Перейти к содержанию

report_groups

В этой статье

(описание будет добавлено при генерации)

Методы API

| Метод | Действие | Описание | |-------|----------|----------|| add | создание группы | Создает новую группу отчетов с указанным именем. || delete | удаление группы | Удаляет группу отчетов по её идентификатору. || list | получение списка групп | Возвращает список всех доступных групп отчетов. || reports_add | добавление отчетов в группу | Добавляет указанные отчеты в существующую группу. || reports_add_group | связывание отчета с группой | Добавляет отчет в группу (через связь групп). || reports_delete | удаление отчетов из группы | Удаляет указанные отчеты из группы. || reports_delete_group | удаление группы из состава отчетов | Удаляет связь между группой и конкретным отчетом. || reports_list | получение списка отчетов в группе | Возвращает список всех отчетов, входящих в указанную группу. || show | просмотр группы | Возвращает детальную информацию о конкретной группе отчетов. || update | обновление группы | Обновляет название существующей группы отчетов. || groups_list | получение списка групп | Возвращает список групп отчетов для указанного идентификатора. |

report_groups/add

Создает новую группу отчетов с указанным именем.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: add
token ✅ string Токен авторизации
name ✅ string Название новой группы отчетов.

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "name=New Group"
Пример успешного ответа 
{
"result": "OK",
"action": "add",
"groups": [
{
"id": 1,
"name": "New Group"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide group name"
}

report_groups/delete

Удаляет группу отчетов по её идентификатору.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"
Пример успешного ответа 
{
"result": "OK",
"action": "delete",
"groups": [
{
"id": 123
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/groups_list

Возвращает список групп отчетов для указанного идентификатора.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=groups_list" \
--data "id=123"
Пример успешного ответа 
{
"result": "OK",
"action": "groups_list",
"reports": [
{
"id": 1,
"name": "Default Group",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
},
{
"id": 2,
"name": "Test Group",
"status": "pending",
"created_at": "2024-02-20T15:45:00Z"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/list

Возвращает список всех доступных групп отчетов.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: list
token ✅ string Токен авторизации

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN"
Пример успешного ответа 
{
"result": "OK",
"action": "list",
"groups": [
{
"id": 1,
"name": "Default Group"
},
{
"id": 2,
"name": "Admin Reports"
}
]
}
Примеры ошибок 
{
"code": -1,
"message": "Error fetching groups"
}

report_groups/reports_add

Добавляет указанные отчеты в существующую группу.

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: reports_add
token ✅ string Токен авторизации
id ✅ integer Идентификатор группы отчетов для добавления элементов.
reports ✅ array<integer> Массив ID отчетов для добавления. Принимает несколько значений: reports[]=1&reports[]=2

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=reports_add" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "reports[]=10" \
--data "reports[]=11"
Пример успешного ответа 
{
"result": "OK",
"action": "reports_add",
"reports": [
{
"id": 10,
"name": "Daily Report"
},
{
"id": 11,
"name": "Weekly Summary"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/reports_add_group

Добавляет отчет в группу (через связь групп).

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: reports_add_group
token ✅ string Токен авторизации
id ✅ integer Идентификатор отчета для добавления в группу
group_id ✅ integer Идентификатор группы, в которую добавляется отчет

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=reports_add_group" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "group_id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "reports_add_group",
"groups": [
{
"id": 1,
"name": "Group A"
},
{
"id": 2,
"name": "Group B"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/reports_delete

Удаляет указанные отчеты из группы.

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: reports_delete
token ✅ string Токен авторизации
id ✅ integer Идентификатор группы отчетов для удаления.
reports ✅ array<integer> Массив ID отчетов для удаления. Принимает несколько значений: reports[]=1&reports[]=2

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=reports_delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "reports[]=1" \
--data "reports[]=2"
Пример успешного ответа 
{
"result": "OK",
"action": "reports_delete",
"reports": [
{
"id": 5,
"name": "Old Report"
}
]
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/reports_delete_group

Удаляет связь между группой и конкретным отчетом.

HTTP-метод: POST

Параметры:

action ✅ string Идентификатор метода: reports_delete_group
token ✅ string Токен авторизации
id ✅ integer Идентификатор отчета для удаления группы из состава
group_id ✅ integer Идентификатор группы, которую необходимо удалить

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=reports_delete_group" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "group_id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "reports_delete_group",
"groups": [
{
"id": 1,
"name": "Default Group"
},
{
"id": 2,
"name": "Monthly Reports"
}
]
}
Примеры ошибок 
{
"code": -400,
"message": "Please provide ID"
}

report_groups/reports_list

Возвращает список всех отчетов, входящих в указанную группу.

HTTP-метод: POST

Параметры:

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

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=reports_list" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "reports_list",
"reports": [
{
"id": 10,
"name": "Daily Usage Report",
"status": "active"
},
{
"id": 11,
"name": "Traffic Statistics",
"status": "pending"
}
]
}
Примеры ошибок 
{
"code": -400,
"message": "Please provide ID"
}

report_groups/show

Возвращает детальную информацию о конкретной группе отчетов.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: show
token ✅ string Токен авторизации
id ✅ integer Уникальный идентификатор группы отчетов

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=5"
Пример успешного ответа 
{
"result": "OK",
"action": "show",
"groups": {
"id": 5,
"name": "Admin Group",
"created_at": "2024-01-15T10:30:00Z"
}
}
Примеры ошибок 
{
"code": 400,
"message": "Please provide ID"
}

report_groups/update

Обновляет название существующей группы отчетов.

HTTP-метод: POST

Параметры:

Параметр Обязательный Тип Описание
action ✅ string Идентификатор метода: update
token ✅ string Токен авторизации
id ✅ integer Уникальный идентификатор группы отчетов
name ✅ string Новое название группы отчетов

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

curl -s "https://invapi.hostkey.ru/report_groups.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=VALUE" \
--data "name=VALUE"
Пример успешного ответа 
{
"result": "OK",
"action": "update",
"groups": {
"id": 5,
"name": "Updated Group Name",
"status": "active"
}
}
Примеры ошибок 
{
"code": -400,
"message": "Please provide ID"
}
question_mark
Я могу вам чем-то помочь?
question_mark
ИИ Помощник ×