Страницы-лидеры домена (get_top_urls)

С 31.12.2021 методы API v3 будут недоступны. Воспользуйтесь аналогичным методом API v4.

Метод get_top_urls возвращает страницы анализируемого домена в иерархическом порядке. Кроме того, он показывает количество ключевых фраз, по которым страница ранжируется в топе (топ-100 Google или топ-50 Яндекс), ориентировочный трафик страниц и количество шейров в социальной сети Facebook. Аналогичен отчету «Страницы-лидеры» в Анализе домена.

Общие параметры запроса и инструкция по использованию Serpstat API

Для пагинации используйте параметры:
page_size: количество результатов на страницу (по умолчанию — 100, максимум —1000)
page: номер страницы (по умолчанию — 1-я страница) — каждое изменение параметра считается новым запросом и влияет на лимиты.

Для сортировки используйте параметры:
sort: поле, по которому нужно выполнить сортировку
order: направление сортировки (asc — по возрастанию, desc — по убыванию).

Параметры ответа
Параметр	Описание
result	Содержит в себе ответ
total	Всего найдено страниц у домен
hits	Содержит в себе ответ
url	Страница домена
organic_keywords	Общее количество ключевых фраз, по которым ранжируется страница в Google топ-100 или Яндекс топ-50
facebook_shares	Количество шейров (репостов) в социальной сети Facebook
potencial_traff	Ориентировочный трафик страницы по ключевому слову в зависимости от частотности ключа и позиции домена.
status_msg	Ответ: «OK» или «Error», сообщает об удачном или неудачном запросе
status_code	Код ответа «200» — успешный запрос. В других случаях — превышение лимитов (количество одновременных запросов или ограничение по лимитам аккаунта)
left_lines	Количество оставшихся API строк

Часть ответа API, за которую снимается 1 лимит:

{
    "url": "https://www.nike.com/",
    "organic_keywords": 65134,
    "facebook_shares": 701305,
    "potencial_traff": 39481276
},

Example

Request data:

api.serpstat.com/v3/get_top_urls?query=nike.com&se=g_us&token=XXX&order=desc&sort=organic_keywords&page_size=100&page=1

Response data:

{
    "result": {
        "total": 147181,
        "hits": [
            {
                "url": "https://www.nike.com/",
                "organic_keywords": 65134,
                "facebook_shares": 701305,
                "potencial_traff": 39481276
            },
            {
                "url": "https://jobs.nike.com/",
                "organic_keywords": 20392,
                "facebook_shares": 614,
                "potencial_traff": 121679
            }
        ]
    },
    "status_msg": "OK",
    "status_code": 200,
    "left_lines": 997717
}