Отримання списку проєктів Моніторингу позицій

Метод 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
size	Кількість результатів на сторінку у відповіді	int	так	100	Числове значення. Можливі значення: 20, 50, 100, 200, 500

Параметри відповіді
Параметри	Опис
id	Ідентифікатор відповіді: відповідає id в запиті
data	Масив з даними відповіді
result	Обʼєкт {...} з інформацією проєкту
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
        }
    }
}