Получение списка проектов Мониторинга позиций

Метод RtApiProjectProcedure.getProjects позволяет получить список ваших проектов с учетом проектов Мониторинга позиций и получить информацию об ID проекта, его названии, дате создания без надобности перехода на саму платформу.

Пример использования: Получите полный список ваших проектов в Мониторинге позиций, чтобы иметь возможность оперативно управлять и анализировать SEO-активности.
1. Отправьте запрос, использовав метод RtApiProjectProcedure.getProjects.
2. Получите и сохраните список проектов с соответствующими данными.
3. Проанализируйте статус каждого проекта и определите необходимые действия (обновление позиций,
настройки, мониторинг).

Общие параметры запроса и инструкция по использованию Serpstat API

Перечень доступных баз и стран

Параметры запроса
Параметр	Описание	Тип	Обязательный	Значение по умолчанию	Варианты значений
id	Идентификатор запроса: ответ содержит этот же идентификатор.	int / string	нет		Любое текстовое или числовое значение. Например: 1, test, тест
method	Название метода API	string	нет		RtApiProjectProcedure.getProjects
params	Объект с параметрами {...}, в нем перечисляются все нижеследующие параметры и массивы [...]		да
page	Номер страницы списка проектов	int	да	1	Числовое значение. Например: 1, 5
pageSize	Размер страницы списка проектов	int	да	100	Числовое значение. Возможные значения: 20, 50, 100, 200, 500

Параметры ответа
Параметры	Описание
id	Идентификатор ответа: соответствует таковому в запросе
result	Массив с данными ответа.
data	Объект {...} с информацией о проекте
id (в массиве data)	id проекта
projectName	Название проекта
domain	Название домена соответствующего проекту
createdAt	Время создания проекта
group	Группа проекта
type	Тип проекта ("owner" — владельцем проекта являетесь вы, "reader" — владельцем проекта является член вашей команды. В случае использования Управления командой.)
status	Статус проекта. 0 - удаленный, 8 - активный и ненастроенный, 9 - активный и настроенный.
enableTracking	Наличие проекта Мониторинга позиций по домену
summary_info	Объект с общими данными
page	Номер страницы
page_total	Общее количество страниц по запросу
count	Количество результатов на странице заданное пользователем
total	Общее количество проектов

Лимиты за этот метод не списываются.

Example

Request data:

{
    "id": 1,
    "method": "RtApiProjectProcedure.getProjects",
    "params": {
        "page": 1,
        "pageSize": 20
    }
}

Response data:

{
    "id": "1",
    "result": {
        "data": [
            {
                "id": "865802",
                "projectName": "serpstat.com",
                "domain": "serpstat.com",
                "createdAt": "2021-04-02 17:58:17",
                "group": "Default group",
                "type": "owner",
                "status": 8,
                "enableTracking": true
            },
            {
                "id": "865801",
                "projectName": "serpstat.com",
                "domain": "serpstat.com",
                "createdAt": "2021-04-02 17:35:34",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            },
            {
                "id": "864988",
                "projectName": "sardayal.ru",
                "domain": "sardayal.ru",
                "createdAt": "2021-03-31 13:29:29",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            },
            {
                "id": "864774",
                "projectName": "insightedge.jp",
                "domain": "insightedge.jp",
                "createdAt": "2021-03-31 00:29:42",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            },
            {
                "id": "864510",
                "projectName": "serpstat.com 3003",
                "domain": "serpstat.com",
                "createdAt": "2021-03-30 16:11:29",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            },
            {
                "id": "864390",
                "projectName": ".chula.ac.th",
                "domain": "chula.ac.th",
                "createdAt": "2021-03-30 13:39:53",
                "group": "Default group",
                "type": "owner",
                "status": 9,
                "enableTracking": true
            }
        ],
        "summary_info": {
            "page": 1,
            "page_total": 5,
            "count": 20,
            "total": 100
        }
    }
}