Отримання списку проєктів і їх статусу
Метод RtApiProjectProcedure.getProjects повертає список проєктів (всіх невидалених) і їхній статус.
Загальні параметри запиту та інструкція щодо використання Serpstat API
Параметри запиту | |||
Параметр | Значення | Опис | |
id | обов'язково | 1 | Ідентифікатор запиту |
method | обов'язково | RtApiProjectProcedure.getProjects | Назва методу API |
params | обов'язково | {...} | Об'єкт з параметрами |
page | опціонально | 1 | Сторінка з результатами відповіді. За замовчуванням — 1 |
pageSize | опціонально | 100 | Кількість результатів на сторінку з відповіддю. За замовчуванням — 100 |
Параметри відповіді | |
Параметр | Опис |
id | Ідентифікатор відповіді: відповідає id в запиті |
result | Містить в собі відповідь |
data | Масив об'єктів |
projectId | Ідентифікатор проєкту |
projectName | Назва проєкту |
domain | Домен, за яким створений проєкт |
createdAt | Дата створення проєкту |
group | Група, до якої прив'язаний проєкт |
type | Тип зв'язку користувача та проєкту: * owner — власник; * read — доступ на читання; * edit — доступ на редагування |
status | Статус проєкту: * 8 — проєкт не налаштовано; * 9 — проєкт налаштовано |
enableTracking | Параметр вказує на те, чи включено в проєкті автоматичне зняття позицій: * true — включено; * false — вимкнено |
summary_info | Блок зведеної інформації |
page | Поточна сторінка |
page_total | Кількість сторінок з результатами при обраному параметрі pageSize |
count | Кількість результатів на сторінку |
total | Загальна кількість результатів |
За цим методом ліміти API не списуються.
{
"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
}
}
}