SEO-проекты · token

`search-systems` Поисковые системы проекта

Отдаёт поисковые системы и регионы, по которым проект снимает позиции, и отмечает приоритетную. Поле id из ответа — тот самый ID поисковой системы проекта, который принимают фильтры других методов. Метод синхронный.

Адрес: /projects/api/v1/search-systems/get
Режим: синхронный
Лимиты: не тратит

Список поисковых систем

GET /projects/api/v1/search-systems/get

Каждая запись — пара «поисковая система + регион», подключённая к проекту. Её id передаётся как ss_id в project/traffic и как search_system_id в competitors/get.

Параметры query

token string обязательный

Ключ API из настроек аккаунта — тот же, что key у методов инструментов.
project_id int обязательный

ID проекта. Виден в адресе страницы проекта и в ответе projects/get.

Ответ

result.project int

ID проекта.
result.search_systems[].id int

ID поисковой системы проекта (связка системы и региона).
result.search_systems[].name string

Название с регионом в скобках.
result.search_systems[].is_priority int

1 — приоритетная система проекта, 0 — нет.
result.search_systems[].region object

id — код региона Яндекса, name — название.
result.search_systems[].engine object

Поисковая система без региона: id, name, alias (yandex, yandex-mobile, google и т. п.).

GET /projects/api/v1/search-systems/get

curl -G 'https://tools.pixelplus.ru/projects/api/v1/search-systems/get' \
  --data-urlencode 'token=ВАШ_КЛЮЧ' \
  --data-urlencode 'project_id=7002'

<?php
$url = 'https://tools.pixelplus.ru/projects/api/v1/search-systems/get?' . http_build_query([
    'token' => 'ВАШ_КЛЮЧ',
    'project_id' => 7002,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/projects/api/v1/search-systems/get",
    params={
        "token": "ВАШ_КЛЮЧ",
        "project_id": 7002,
    },
    timeout=60,
)
print(response.json())

project_id обязательный ID проекта. Виден в адресе страницы проекта и в ответе projects/get

Запрос настоящий — выполнится с вашим ключом

Пример ответа

{
    "status": "ok",
    "code": 1,
    "msg": "success",
    "result": {
        "project": 7002,
        "search_systems": [
            {
                "id": 1,
                "name": "Яндекс (Москва)",
                "is_priority": 1,
                "region": {
                    "id": "213",
                    "name": "Москва"
                },
                "engine": {
                    "id": "1",
                    "name": "Яндекс",
                    "alias": "yandex"
                }
            },
            {
                "id": 324,
                "name": "Яндекс (мобильный) (Москва)",
                "is_priority": 0,
                "region": {
                    "id": "213",
                    "name": "Москва"
                },
                "engine": {
                    "id": "7",
                    "name": "Яндекс (мобильный)",
                    "alias": "yandex-mobile"
                }
            }
        ]
    }
}

Ошибки

Код	Сообщение	Когда
`50`	`access error`	Токен не передан, не найден, или у его владельца нет доступа к проекту.
`52`	`wrong request data`	Проекта с таким `project_id` нет.

Ответ с ошибкой

{
    "status": "error",
    "code": 50,
    "msg": "access error",
    "result": []
}