Инструменты · key

`struktura` Структура сайта по индексу Яндекса

Восстанавливает структуру сайта по индексу Яндекса: находит разделы первого и второго уровня, считает, сколько страниц каждого раздела в индексе, и какую долю сайта он занимает. Метод синхронный — результат приходит в ответе на тот же запрос.

Режим: синхронный, ответ до нескольких минут
Поисковая система: Яндекс, регион Москва (213)
Лимиты: нужен положительный остаток; за вызов не списываются

Структура сайта

GET /api/struktura

Сначала метод собирает папки первого уровня из выдачи по url:домен/* и дособирает менее крупные, исключая семь самых больших. Затем «разворачивает» до второго уровня семь крупнейших разделов и для каждой найденной папки запрашивает число документов в индексе.

Параметры query

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

Ключ API из настроек аккаунта.
domain string обязательный

Домен сайта. Можно передать в query или в теле POST.

Ответ

Во всех трёх словарях ключ — раздел. Первый ключ — корень сайта в виде домен/, остальные — пути от корня: /uslugi/, /uslugi/seo. Разделы отсортированы по убыванию числа документов. Если по домену в индексе ничего нет, приходит пустой массив [].

all object

Раздел → число документов в индексе Яндекса. У корня — всего по сайту, строкой.
percent object

Раздел → доля от всего сайта в процентах, до 0,1.
count_slash object

Раздел → число слешей в ключе. Нужно, чтобы вывести разделы деревом: чем больше, тем глубже вложенность.
first object

Корень сайта отдельно.
Вложенные поля
- domain string
  
  Корень, как первый ключ словарей: домен/.
- count string
  
  Документов в индексе по всему сайту.

GET /api/struktura

curl -G 'https://tools.pixelplus.ru/api/struktura' \
  --data-urlencode 'key=ВАШ_КЛЮЧ' \
  --data-urlencode 'domain=pixelplus.ru'

<?php
$url = 'https://tools.pixelplus.ru/api/struktura?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
    'domain' => 'pixelplus.ru',
]);

$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/api/struktura",
    params={
        "key": "ВАШ_КЛЮЧ",
        "domain": "pixelplus.ru",
    },
    timeout=60,
)
print(response.json())

domain обязательный Домен сайта. Можно передать в query или в теле POST

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

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

{
    "count_slash": {
        "pixelplus.ru/": 1,
        "/uslugi/": 2,
        "/blog/": 2,
        "/uslugi/seo": 2
    },
    "percent": {
        "pixelplus.ru/": 100,
        "/uslugi/": 31.4,
        "/blog/": 22.8,
        "/uslugi/seo": 9.6
    },
    "all": {
        "pixelplus.ru/": "1853",
        "/uslugi/": 582,
        "/blog/": 423,
        "/uslugi/seo": 178
    },
    "first": {
        "domain": "pixelplus.ru/",
        "count": "1853"
    }
}

Ошибки

Код	Сообщение	Когда
`-50`	`Not set`	Не передан `domain`. Имя параметра приходит ключом ответа, HTTP-код `200`.
`-1`	`Access denied`	Не передан `key`. HTTP `404`.
`-2`	`Access denied`	Ключ не найден. HTTP `403`.
`-68, -80…-83`	`Not enough … limits`	Лимиты исчерпаны: дневные (`-68`), часовые (`-80`), недельные (`-81`), месячные (`-82`), годовые (`-83`). В ответе также `available` и `need`.

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

{
    "domain": "Not set",
    "code": "-50"
}

Метод делает несколько десятков запросов к выдаче Яндекса, поэтому ответ может идти несколько минут — ставьте таймаут HTTP-клиента с запасом. Число документов — оценка Яндекса для оператора url:, а не точный счёт страниц. Раздел, по которому Яндекс ничего не нашёл, получает 1, а не 0.