API для маркетинг-плана
Список пунктов плана
Возвращает список разделов, пунктов и информацию об отметках плана.
Формат запроса
Параметры в запросе
| Имя | Обязательный | Описание |
| site_id | Да | ID сайта |
Результат
В случае успеха сервер возвращает список разделов, пунктов и информацию об отметках плана.
Пример
[
{
«title»: «Шаг 1. Анализ и подбор ключевых слов»,
«items»: [
{
«id»: «analyze_competitors»,
«title»: «Изучите ключевые слова конкурентов»,
«checked»: true
},
{
«id»: «makeup_final_list»,
«title»: «Сформируйте семантическое ядро сайта»,
«checked»: true
},
…
],
«id»: «keywords_research»,
«items_count»: 3,
«items_checked»: 3
},
…
]
Параметры ответа
| Имя | Описание |
| id | ID раздела |
| title | Название раздела |
| items_count | Количество задач в разделе |
| items_checked | Количество выполненных задач |
| items | Задачи раздела |
Задачи раздела
| Имя | Описание |
| id | ID задачи |
| title | Название задачи |
| checked | Статус задачи |
Добавление задачи
Формат запроса
POST /checklist/{site_id}/task
{
«title»: «text»,
«text»: «text description»,
«for_all» : false
}
Параметры в запросе
| Имя | Обязательный | Описание |
| title | Да | Название |
| text | Да | Описание |
| for_all | Нет | Для всех проектов |
Результат
В случае успеха сервер возвращает id созданного таска.
Пример ответа
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Empty title |
| 400 | Empty text |
Изменение задачи
Формат запроса
PUT /checklist/{site_id}/task/
{
«task_id» : «makeup_final_list»,
«title»: «text»,
«text»: «text description»,
}
Параметры в запросе
| Имя | Обязательный | Описание |
| task_id | Да | ID Задачи |
| title | Да | Название |
| text | Да | Описание |
Результат
В случае успеха сервер возвращает HTTP 200.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 400 | Empty title |
| 400 | Empty text |
Удаление задачи
Удалить можно только задачи, созданные методом (POST /checklist/{site_id}/task)
Формат запроса
DELETE /checklist/{site_id}/task/{task_id}
Результат
В случае успеха сервер возвращает HTTP 204.
Установка статуса задачи
Формат запроса
PUT /checklist/{site_id}/task/
{
«task_id» : «makeup_final_list»,
«checked»: true
}
Параметры в запросе
| Имя | Обязательный | Описание |
| task_id | Да | ID задачи |
| checked | Да | true-выполнен |
Результат
В случае успеха сервер возвращает HTTP 200.