Отримання статусу проекту
Метод RtApiSearchEngineProcedure.getProjectStatus повертає дані про статус автоматичного зняття позицій проекту.
Приклади використання:
1. Для перевірки чи активне автоматичне зняття позицій для конкретного проєкту.
2. Для перевірки статусу автоматичного зняття позицій проєкту в випадку пониження/підвищення тарифу.
3. Для визначення керівником команди статусу проєктів з активним автоматичним зняттям позицій як
свого акаунту, так і акаунтів, що входять до його команди.
Загальні параметри запиту та інструкція щодо використання Serpstat API
Доступні пошукові бази
Параметри запиту | ||||
Параметр | Опис | Тип | Обов'язковий | Варіанти значень |
id | Ідентифікатор запиту: відповідь буде містити цей же ідентифікатор | int/string | так | Будь-яке числове або текстове значення. |
method | Назва методу API | string | так | RtApiSearchEngineProcedure.getProjectStatus |
params | Об'єкт з параметрами {...}, в ньому перераховуються всі нижченаведені параметри та масиви [...] |
| так | |
projectId | Ідентифікатор проєкту | number | так | Числове значення ідентифікатору проєкту |
regionId | Ідентифiкатор регіону | number | ні | Числове значення ідентифікатору регіону. При не вказаному "regionId" в запиті, система переглядає всі регіони проєкту, і якщо хоча б в одному з них активоване автоматичне зняття позицій - повертає значення "true" по цьому регіону. |
Параметри відповіді | |
Параметр | Опис |
id | Ідентифікатор відповіді: відповідає id в запиті |
result | Містить в собі відповідь |
data | Об'єкт з даними |
projectId | Ідентифікатор проєкту |
regionId | Ідентифікатор регіону |
parsing | Статус автоматичного зняття позицій проекту. true - автоматичне зняття позицій увімкнено, false - автоматичне зняття позицій вимкнено. |
За цим методом ліміти API не списуються.
{
"id": 1,
"method": "RtApiProjectProcedure.getProjectStatus",
"params": {
"projectId": 1127317,
"regionId": 3245
}
}
{
"id": "1",
"result": {
"projectId": 1127317,
"regionId": 32423423,
"parsing": false
}
}