Содержание
API для групп ключевых слов
Добавление группы для ключевых слов
Метод позволяет добавить группу для ключевых слов проекта.
Параметры
| Имя | Обязательный | Описание |
| name | Да | Имя добавляемой группы для ключевых слов проекта |
| site_id | Да | ID проекта, в который будет добавлена группа для ключевых слов |
Формат запроса
POST https://api4.seranking.com/keyword-groups
{
«name»: «groupname»,
«site_id»: 1
}Результат
В случае успеха сервер возвращает HTTP 201 и массив, содержащий id добавленной группы для ключевых слов проекта.
| Имя | Обязательный | Описание |
| group_id | Да | ID добавленной группы для ключевых слов проекта |
Пример ответа
{ «group_id»: 123456}Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Empty name |
| 404 | Empty site_id |
Перенос ключевых слов в другую группу
Метод позволяет перенести ключевые слова проекта из одной группы в другую.
Параметры
| Имя | Обязательный | Описание |
| keyword_ids | Да | Массив ID переносимых ключевых слов |
Формат запроса
POST /keyword-groups/{group_id}/keywords
{
«keywords_ids»: [1,2,3,4,5]
}Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Group not found |
Изменение названия группы ключевых слов
Метод позволяет изменить название группы ключевых слов проекта.
Параметры
| Имя | Обязательный | Описание |
| name | Да | Новое название группы ключевых слов |
Формат запроса
PUT /keyword-groups/{group_id}
{
«name»: «new name»
}Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Empty name |
| 404 | Group not found |
Удаление группы ключевых слов
Метод позволяет удалить группу ключевых слова проекта.
Формат запроса
DELETE /keyword-groups/{group_id}Результат
В случае успеха сервер возвращает HTTP 204.
Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | Group not found |
Получение списка групп ключевых слов
Метод позволяет получить список групп ключевых слов для указанного проекта.
Формат запроса
GET /keyword-groups/{site_id}Результат
В случае успеха сервер возвращает массив со списком групп ключевых слов для указанного проекта.
| Имя | Обязательный | Описание |
| name | Да | Название группы ключевых слов проекта |
| id | Да | ID группы ключевых слов проекта |
| creation_date | Да | Дата создания группы ключевых слов проекта |
Пример ответа
[
{
«id»: «123»,
«name»: «NewKeyGroup»,
«creation_date»: «2018-08-27»
},
{
«id»: «456»,
«name»: «NewKeyGroup1»,
«creation_date»: «2018-08-27»
},
{
«id»: «789»,
«name»: «NewKeyGroup2»,
«creation_date»: «2018-08-27»
}
]Ошибки
| HTTP-код | Сообщение об ошибке |
| 404 | No keywords ids in request |
| 404 | Group not found |