Получение списка проектов и их статуса
Метод RtApiProjectProcedure.getProjects возвращает список проектов (всех неудаленных) и их статуса.
Общие параметры запроса и инструкция по использованию Serpstat API
Параметры запроса | |||
Параметр | Значение | Описание | |
id | обязательно | 1 | Идентификатор запроса |
method | обязательно | RtApiProjectProcedure.getProjects | Название метода API |
params | обязательно | {...} | Объект с параметрами |
page | опционально | 1 | Cтраница с результатами ответа. По умолчанию — 1 |
pageSize | опционально | 100 | Количество результатов на страницу с ответом. По умолчанию — 100 |
Параметры ответа | |
Параметр | Описание |
id | Идентификатор запроса: соответствует id в запросе |
result | Содержит в себе ответ |
data | Массив объектов |
projectId | Идентификатор проекта |
projectName | Название проекта |
domain | Домен, по которому создан проект |
createdAt | Дата создания проекта |
group | Группа, к которой привязан проект |
type | Тип связи пользователя и проекта: * owner — владелец; * read — доступ на чтение; * editor — доступ на редактирование. |
status | Статус проекта: * 8 — проект в Мониторинге позиций не настроен; * 9 — проект в Мониторинге позиций настроен. |
enableTracking | Параметр указывает на то, включено ли в проекте автоматическое снятие позиций: * true — включено; * false — выключено |
summary_info | Блок сводной информации |
page | Текущая страница |
page_total | Количество страниц с результатами при выбранном параметре pageSize |
count | Количество результатов на страницу с ответом |
total | Общее количество результатов |
По этому методу лимиты не списываются.
{
"id": 1,
"method": "RtApiProjectProcedure.getProjects",
"params": {
"page": 1,
"pageSize": 10
}
}
{
"id": "1",
"result": {
"data": [
{
"id": "898826",
"projectName": "northwestnumbersltd.co.uk",
"domain": "northwestnumbersltd.co.uk",
"createdAt": "2021-06-11 14:52:03",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "897094",
"projectName": "ganeshaspeaks.com",
"domain": "ganeshaspeaks.com",
"createdAt": "2021-06-08 15:31:40",
"group": "Default group",
"type": "owner",
"status": 8,
"enableTracking": true
},
{
"id": "890650",
"projectName": "splitmyfare.co.uk",
"domain": "splitmyfare.co.uk",
"createdAt": "2021-05-26 11:17:30",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": false
},
{
"id": "853932",
"projectName": "adidas.com",
"domain": "adidas.com",
"createdAt": "2021-03-10 10:48:23",
"group": "Default group",
"type": "owner",
"status": 9,
"enableTracking": true
},
{
"id": "829378",
"projectName": "eschareschartsts.com",
"domain": "escharts.com",
"createdAt": "2021-01-20 18:27:06",
"group": "Default group",
"type": "editor",
"status": 9,
"enableTracking": true
}
],
"summary_info": {
"page": 1,
"page_total": 1,
"count": 50,
"total": 30
}
}
}