Индикаторы проекта¶
Запустить любой из процессов на странице Состояние проекта¶
POST https://cloud.roistat.com/api/v1/project/health/indicator/{indicatorId}/run-scriptВ разделе Состояние проекта отображаются основные процессы проекта, некоторые из которых можно запускать самостоятельно с помощью кнопки Запустить.
С помощью данного метода API вы можете запускать любой из процессов на этой странице, даже те, для которых в интерфейсе нет кнопки запуска.
Чтобы получить indicatorId, воспользуйтесь методом /project/health/indicator/list.
curl 'https://cloud.roistat.com/api/v1/project/health/indicator/12345/run-script?project=12345' \
--request POST \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}'
{
"execution_status": "success",
"status": "success"
}
Строка запроса:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| project | string | Номер проекта | да |
Тело запроса:
Без параметров.
| Параметр | Тип | Описание |
|---|---|---|
| execution_status | string | статус запуска: - success - запущен; - error - ошибка запуска. |
| status | string |
Получить идентификаторы процессов на странице Состояние проекта¶
GET https://cloud.roistat.com/api/v1/project/health/indicator/listС помощью данного метода можно получить идентификаторы процессов на странице Состояние проекта.
curl 'https://cloud.roistat.com/api/v1/project/health/indicator/list?project=12345' \
--request GET \
--header 'Content-type: application/json' \
--header 'Api-key: {KEY}'
{
"data": [
{
"name": "Интеграция с CRM",
"indicators": [
{
"id": 1,
"name": "Загрузка данных",
"status": 1,
"messages": [
{
"s": 1,
"m": "Загружено и обновлено 0 сделок.",
"d": "2022-07-26 12:24:21"
}
],
"is_executable": true,
"is_running": false
},
{
"id": 2,
"name": "Отправка недоставленных лидов (proxy lead)",
"status": 1,
"messages": [
{
"s": 1,
"m": "Отправлено 0 лидов",
"d": "2022-07-26 11:26:42"
}
],
"is_executable": true,
"is_running": false
},
{
"id": 8,
"name": "Загрузка клиентов",
"status": 3,
"messages": [
{
"s": 3,
"m": "Произошла неизвестная ошибка",
"d": "2022-06-16 19:46:00"
}
],
"is_executable": true,
"is_running": false
}
]
},
{
"name": "Счетчик на сайте",
"indicators": [
{
"id": 3,
"name": "Обработка визитов с сайта",
"status": 1,
"messages": [
{
"s": 1,
"m": "Обработано 0 визитов",
"d": "2022-07-26 12:29:48"
}
],
"is_executable": true,
"is_running": false
}
]
},
{
"name": "SMM",
"indicators": [
{
"id": 4,
"name": "Загрузка сообщений",
"status": 1,
"messages": [
{
"s": 1,
"m": "Загрузка завершена",
"d": "2022-07-26 12:38:31"
}
],
"is_executable": true,
"is_running": false
},
{
"id": 5,
"name": "Обновление доступных аккаунтов",
"status": 1,
"messages": [
{
"s": 1,
"m": "Обновление завершено",
"d": "2022-07-26 04:00:50"
}
],
"is_executable": true,
"is_running": false
}
]
},
{
"name": "Email-трекинг",
"indicators": [
{
"id": 6,
"name": "Загрузка писем",
"status": 1,
"messages": [
{
"s": 1,
"m": "Загружено 0 писем",
"d": "2022-07-26 12:39:01"
}
],
"is_executable": true,
"is_running": false
}
]
},
{
"name": "Аналитика",
"indicators": [
{
"id": 7,
"name": "Обновление таблицы аналитики",
"status": 1,
"messages": [
{
"s": 1,
"m": "Таблица аналитики обновлена",
"d": "2022-07-26 10:20:53"
}
],
"is_executable": true,
"is_running": false
}
]
},
{
"name": "Клиенты",
"indicators": [
{
"id": 9,
"name": "Построение сегментов",
"status": 1,
"messages": [
{
"s": 1,
"m": "Сегмент #2 (Старые клиенты) успешно построен",
"d": "2022-07-26 04:44:28"
},
{
"s": 1,
"m": "Сегмент #1 (Покупки 20.06 - 25.06) успешно построен",
"d": "2022-07-26 04:44:28"
}
],
"is_executable": true,
"is_running": false
}
]
}
],
"status": "success"
}
Строка запроса:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| project | string | Номер проекта | да |
Тело запроса:
Без параметров.
| Параметр | Тип | Описание |
|---|---|---|
| data | array[object] | |
| > name | string | Категория процессов |
| > indicators | array[object] | Информация о процессах в данной категории |
| >> id | integer | ID процесса |
| >> name | string | Название процесса |
| >> status | integer | Текущий статус процесса: 1 – процесс завершен успешно; 2 – процесс завершен с ошибками; 3 – процесс не завершен |
| >> messages | array[object] | Сообщения о процессе (история действий) |
| >>> s | integer | Статус процесса на момент сообщения: 1 – процесс завершен успешно; 2 – процесс завершен с ошибками; 3 – процесс не завершен |
| >>> m | string | Текст сообщения |
| >>> d | string | Дата совершения действия |
| >> is_executable | boolean | Флаг, показывающий, возможно ли выполнить процесс |
| >> is_running | boolean | Флаг, показывающий, выполняется ли процесс в данный момент |
| status | string | Статус запроса |