API для анализа конкурентов

Добавление конкурента в проект

Метод позволяет добавить сайт конкурента в проект для отслеживания позиций.

Параметры

Формат запроса

POST /competitors

{

site_id : 1,

name : “name”,

url : “https://site.test.com/”

} 

Результат

В случае успеха сервер возвращает HTTP 201 и id добавленного конкурента.

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

{

“id”: 123456

}

Ошибки

Получение списка конкурентов проекта

Метод позволяет получить список всех конкурентов добавленных в проект.

Формат запроса

GET /competitors/site/{site_id}

Результат

В случае успеха сервер возвращает массив со списком конкурентов, добавленных в проект, и статистику по сайтам конкурентов.

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

[

    {

        “id”: 1,

        “name”: “competitor1.com”,

        “url”: “competitor1.com”,

    },

    {

        “id”: 2,

        “name”: “competitor2.com”,

        “url”: “https://competitor2.com/”,

    },

    {

        “id”: 3,

        “name”: “competitor3.com”,

        “url”: “https://competitor3.com”,

    }

]

Позиции по ключевым словам конкурентов

Метод позволяет получить статистику проверки позиций по ключевым словам конкурента, добавленного в проект.

Формат запроса

GET /competitors/{competitor_id}/positions?date_from=2018-07-25&date_to=2018-07-25&site_engine_id=1

Query-параметры запроса

Результат

В случае успеха сервер возвращает массив со статистикой позиций по ключевым словам конкурента, добавленного в проект. Возвращает максимум 300000 записей позиций (positions).

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

[

    {

        “site_engine_id”: 123,

        “keywords”:[

            {

                “id”: “123”,

                “positions”:[

                    {

                        “date”: “2018-07-25”,

                        “pos”: 7,

                        “change”: 1

                    }

                ]

            }

        ],

        “name”: null,

        “volume”: null

    },

…

]

Ошибки

Удаление конкурента из проекта

Метод позволяет удалить сайт конкурента из проекта пользователя.

Формат запроса

DELETE /competitors/{competitor_id}

Результат

В случае успеха сервер вернет HTTP 204.

Ошибки

Получение ТОП 10 по ключевому слову

Метод позволяет получить список результатов из ТОП 10 по ключевым словам, отслеживаемым в проекте.

Формат запроса

GET /competitors/top10/{site_id}/?date=2018-01-01&site_engine_id=1&keyword_id=1

Query-параметры запроса

Результат

В случае успеха сервер возвращает массив со списком сайтов из ТОП 10.

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

[

    {

        “url”: “https://www.tests.com/login”,

        “position”: 1,

        “keyword_id”: 1,

        “da”: null,

        “backlinks”: “328”,

        “domains”: “32”,

        “yandex_x”: null

    },

    …

]

Получение ТОП 100 по ключевому слову

Метод позволяет получить список результатов из ТОП 100 по ключевым словам, отслеживаемым в проекте.

Формат запроса

GET /competitors/top100/{site_id}/?date=2018-01-01&site_engine_id=1&keyword_id=1

Query-параметры запроса

Результат

В случае успеха сервер возвращает массив со списком сайтов из ТОП 100.

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

[

    {

        “url”: “https://www.tests.com/login”,

        “position”: 1,

        “date”: “2018-01-01”

    },

    {

        “url”: “https://www.test2.com,

        “position”: 2,

        “date”: “2018-01-01”

    },

    …

]

Все конкуренты

Информация о сайтах, которые были в ТОП-10 по каждому из отслеживаемых запросов. История сохраняется 14 дней.

Формат запроса

GET /competitors/all/{site_id}/?date=2018-01-01&site_engine_id=1&group_id=1&tags[]=21

Query-параметры запроса

Результат

В случае успеха сервер возвращает массив со списком сайтов из ТОП 10.

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

[

{

    “domain”: “www.tests.com”,

    “domain_id”: 10,

    “visibility”: 0,

    “da”: null,

    “backlinks”: “328”,

    “domains”: “32”,

    “yandex_x”: null

},

…

]