SEOньоритаДокументация API
API v1Подбор ключей
Public API v1

Подбор ключей

Расширение Wordstat, строки результата и импорт выбранных фраз.

GET/projects/{projectId}/keyword-research-runsИстория подбора ключейresearch:read

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

Path: projectId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
POST/projects/{projectId}/keyword-research-runsСоздать подбор ключейresearch:run

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

Path: projectId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
GET/projects/{projectId}/keyword-research-runs/{runId}Состояние подбора ключейresearch:read

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

Path: projectId: UUID, runId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
GET/projects/{projectId}/keyword-research-runs/{runId}/rowsСтроки подбора с курсоромresearch:read

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

Path: projectId: UUID, runId: UUID. JSON body отсутствует, если для метода явно не указано обратное.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
POST/projects/{projectId}/keyword-research-runs/{runId}/confirmПодтвердить выбранные строки и импортresearch:run

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

Path: projectId: UUID, runId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
POST/projects/{projectId}/keyword-research-runs/{runId}/cancelОтменить подбор ключейresearch:run

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

Path: projectId: UUID, runId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.
POST/projects/{projectId}/keyword-research-runs/{runId}/retry-importПовторить импорт готового результатаresearch:run

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

Path: projectId: UUID, runId: UUID. Content-Type: application/json; неизвестные поля отклоняются.

Формат ответа

JSON { data: <типизированный результат>, meta: { requestId }, page?: { hasNext, nextCursor } }.