Отримання списку проєктів Моніторингу позицій
Метод RtApiProjectProcedure.getProjects дозволяє отримати список ваших проєктів та отримати інформацію про ID вашого проєкту, його назву та дату створення без необхідності переходу на саму платформу.
Параметри запиту | |||||
Параметри | Опис | Тип | Опціональний | Значення за замовчуванням | Варіанти значень |
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 | Загальна кількість проєктів |
Ліміти за цей метод не знімаються.
{
"id": 1,
"method": "RtApiProjectProcedure.getProjects",
"params": {
"page": 1,
"pageSize": 20
}
}
{
"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
}
}
}