API v1 задания в инструменте Частотность/WS

Для начала работы с API SEOWORK необходимо обратиться в поддержку по почте help@seowork.ru или в чат на сайте. Для вас будет создан API токен.

По API можно:

Запустить задание в инструменте Частотность/WS,
Получить детализацию по выполненному заданию в инструменте Частотность/WS .

Формат POST запроса на постановку задачи в инструменте Частотность/WS

POST (JSON)

https://seowork.ru/api/v1/frequency/client/ru?token=<CLIENT_TOKEN>

Имя	Обязательный	Тип	Значение по умолчанию	Описание
database_id	да	int		0 - Все 1-Мобильные, 2 - Только телефоны, 3 - Только планшеты, 4 - Дэсктопы
region_id	да	int		Регион яндекса
config	да	int		0 - "WS?" 1 - "WS" 2 - "«WS»" 3- "«!WS»" 4 - "[WS]" 5 - "«[WS]»" 6 - "«[!WS]»"

В тело запроса запроса указываем также запросы, по которым нужно снять частотность. Запросы через запятую указываются в массиве queries.

Важно по API есть ограничение на кол-во запросов в задании до 100 000.

Свойство задания config перечисляемое, вы также можете указать все типы частотности для задания.

{
    "database_id": 2,
    "region_id": 213,
    "config":
    [
        0,
        1,
        2,
        3
    ],    
    "queries":
    [
        "купить носки",
        "купить футболку"
    ]
}

Если задание создалось, то будет 201 ответ и id созданного задания. Пример ниже.

{
    "has_data": true,
    "data": {
        "task_id": 75874
    },
    "version": null,
    "status": 201,
    "error": 0,
    "error_messages": [],
    "response_time": 4.316596031188965,
    "server_timestamp": "2021-09-13 12:31:16",
    "server_unixtimestamp": 1631536276
}

Если вы указали некорректно параметры или не указали значение для параметра, то вы увидите код ответа 400, пример ниже.

{
    "data":
    {
        "errors":
        {
            "*":
            [
                "Отсутствуют одно из обязательных полей (mode, config, region_id, database_id)"
            ]
        }
    },    "version": null,
    "status": 400,
    "error": 0,
    "error_messages":
    [

    ],
    "time": 0.140267133712769
}

Формат GET запроса на получение детализации по заданию в инструменте Частотность/WS

GET

https://seowork.ru/api/v1/frequency/client/ru/detail/<task_id>?token=<CLIENT_TOKEN>

В строке/заголовках запроса укажите следующие параметры:

Имя	Обязательный	Тип	Значение по умолчанию	Описание
task_id	да	int		id задания

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

{
    "has_data": true,
    "data": {
        "items": [
            {
                "id":888,
                "query": {
                    "id": 111,
                    "name":"заказать эвакуатор в спб дешево и быстро",
                },
                "statistic": {
                    "count":4,
                    "finished":4
                },
                "status": {
                    "value": 1,
                    "text": "OK"
                },
                "data":{
                    "type_1":22,
                    "type_2":33,
                    "type_4":44,
                    "type_5":null
                }
            },
            {
                "id":999,
                "query": {
                    "id": 222,
                    "name":"эвакуатор спб дешево и быстро приморском районе"
                },    
                "statistic": {
                    "count":4,
                    "finished":4
                },
                "status": {
                    "value": 1,
                    "text": "OK"
                },
                "data":{
                    "type_1":22,
                    "type_2":null,
                    "type_4":44,
                    "type_5":null
                }
            }
        ],
        "offset": 0,
        "per_page": 2,
        "has_more": true,
        "total": 2476
    },
    "version": null,
    "status": 200,
    "error": 0,
    "error_messages": [],
    "time": 2.327794075012207
}