Для начала работы с API SEOWORK необходимо обратиться в поддержку по почте help@seowork.ru или в чате на сайте. Для вас будет создан API токен для работы.
В системе SEOWORK должны быть добавлены и настроены проекты в разделе Видимость
Какие данные можно получить по API:
Список доступных проектов
Категории
Группы (страниц)
Выборки (группы страниц)
Запросы
Документы (страницы)
Метрики проекта
Метрики отдельной сущности
Список доступных проектов или по конкретному проекту
GET-Запрос
https://seowork.ru/semantics/api/v1/project?token={token}&page=1
В заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержится список доступных проектов с перечислением их свойств:
Для получения информации по конкретному проекту используйте запрос вида:
https://seowork.ru/semantics/api/v1/project/{project_id}?token={token}
В строке/заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список доступных проектов с перечислением их свойств:
{
"data": {
"id": 2481,
"name": "*.com",
"description": "",
"is_mobile": false,
"statistics": {
"queries_count": 680,
"group_count": 0,
"query_group_count": 1
},
"frequency": {
"WS1": "WS",
"WS2": "«WS»",
"WS3": "«!WS»",
"database": "Все"
},
"region": {
"id": 213,
"name": "Москва"
},
"search_engines": {
"yandex": "Яндекс",
"google": "Google"
}
},
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}Категории
GET-Запрос
http://seowork.ru/semantics/api/v1/category?token={token}&project_id={project_id}&page={page}
В заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список категорий с перечислением их свойств:
Группы
GET-Запрос
http://seowork.ru/semantics/api/v1/group?token={token}&project_id={project_id}&page={page}
В заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список групп страниц с перечислением их свойств:
Выборки
GET-Запрос
http://seowork.ru/semantics/api/v1/query_group?token={token}&project_id={project_id}&page={page}
В заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список выборок с перечислением их свойств:
Запросы
GET-Запрос
http://seowork.ru/semantics/api/v1/query?token={token}&project_id={project_id}&page={page}
В заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список запросов с перечислением их свойств:
Документы
GET-Запрос
http://seowork.ru/semantics/api/v1/url?token={token}&project_id={project_id}&page={page}
В заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержится список документов (страниц) с перечислением их свойств:
Метрики проекта
GET-Запрос
http://seowork.ru/semantics/api/v1/dashboard/project/{project_id}?token={token}
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержатся значения метрик проекта:
Метрики сущности
Для получения информации в разрезе каждой сущности используйте следующие запросы:
Формат запроса метрик категории
http://seowork.ru/semantics/api/v1/dashboard/category/{category_id}?token={token}&project_id={project_id}&date={date}
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержатся значения метрик проекта:
{
"data": [
{
"date": "2020-02-25",
"document_count": 5,
"query_count": 151,
"category_count": 1,
"position_prc": 42.41,
"ws1": 67465,
"ws2": 8956,
"ws3": 5276,
"top3_count": 0,
"top5_count": 3,
"top10_count": 11,
"top100_count": 132,
"ws1_top10": 3265,
"ws2_top10": 488,
"p_traf": 7.28,
"p_traf_top10": 7.28,
"worth": 0,
"worth_max": 0,
"worth_reserve": 0,
"worth_prc": 0,
"top3_prc": 0,
"top5_prc": 1.99,
"top10_prc": 7.28,
"top100_prc": 87.42,
"ws1_top10_prc": 4.84,
"ws2_top10_prc": 5.45,
"p_traf_prc": 0.78,
"trafic_sum": 0,
"trafic_yandex_sum": 0,
"trafic_google_sum": 0,
"trafic_avg": 0,
"trafic_avg_real": 0
}
],
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}Формат запроса метрик группы
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержатся значения метрик проекта:
{
"data": [
{
"date": "2020-02-25",
"document_count": 68,
"query_count": 4022,
"category_count": 11,
"position_prc": 30.45,
"ws1": 4978401,
"ws2": 320624,
"ws3": 211626,
"top3_count": 766,
"top5_count": 1115,
"top10_count": 1643,
"top100_count": 3465,
"ws1_top10": 967601,
"ws2_top10": 96939,
"p_traf": 4473.12,
"p_traf_top10": 4473.12,
"worth": 0,
"worth_max": 0,
"worth_reserve": 0,
"worth_prc": 0,
"top3_prc": 19.05,
"top5_prc": 27.72,
"top10_prc": 40.85,
"top100_prc": 86.15,
"ws1_top10_prc": 19.44,
"ws2_top10_prc": 30.23,
"p_traf_prc": 13.95,
"trafic_sum": 0,
"trafic_yandex_sum": 0,
"trafic_google_sum": 0,
"trafic_avg": 0,
"trafic_avg_real": 0
}
],
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}Формат запроса метрик выборки
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержатся значения метрик проекта:
{
"data": [
{
"date": "2020-02-19",
"document_count": 51,
"query_count": 287,
"category_count": 21,
"position_prc": 66.05,
"ws1": 245665,
"ws2": 30111,
"ws3": 18013,
"top3_count": 0,
"top5_count": 0,
"top10_count": 0,
"top100_count": 173,
"ws1_top10": 0,
"ws2_top10": 0,
"p_traf": 0,
"p_traf_top10": 0,
"worth": 0,
"worth_max": 0,
"worth_reserve": 0,
"worth_prc": 0,
"top3_prc": 0,
"top5_prc": 0,
"top10_prc": 0,
"top100_prc": 60.28,
"ws1_top10_prc": 0,
"ws2_top10_prc": 0,
"p_traf_prc": 0
}
],
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}Формат запроса метрик документа
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержатся значения метрик проекта:
{
"data": [
{
"date": "2020-02-25",
"document_count": 1,
"query_count": 68,
"category_count": 1,
"position_prc": 68.01,
"ws1": 2314919,
"ws2": 77646,
"ws3": 55070,
"top3_count": 0,
"top5_count": 0,
"top10_count": 0,
"top100_count": 42,
"ws1_top10": 0,
"ws2_top10": 0,
"p_traf": 0,
"p_traf_top10": 0,
"worth": 0,
"worth_max": 0,
"worth_reserve": 0,
"worth_prc": 0,
"top3_prc": 0,
"top5_prc": 0,
"top10_prc": 0,
"top100_prc": 61.76,
"ws1_top10_prc": 0,
"ws2_top10_prc": 0,
"p_traf_prc": 0,
"trafic_sum": 0,
"trafic_yandex_sum": 0,
"trafic_google_sum": 0,
"trafic_avg": 0,
"trafic_avg_real": 0
}
],
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}Формат запроса метрик запроса
В строке/заголовках запроса укажите следующие параметры:
Формат ответа
Объект в формате json, в котором содержится список запросов с перечеслением их свойств:
{
"data": [
{
"date": "2020-02-25",
"document_count": 1,
"query_count": 1,
"category_count": 1,
"position_prc": 16,
"ws1": 57,
"ws2": 32,
"ws3": 30,
"top3_count": 0,
"top5_count": 0,
"top10_count": 0,
"top100_count": 1,
"ws1_top10": 0,
"ws2_top10": 0,
"p_traf": 0,
"p_traf_top10": 0,
"worth": 0,
"worth_max": 0,
"worth_reserve": 0,
"worth_prc": 0,
"top3_prc": 0,
"top5_prc": 0,
"top10_prc": 0,
"top100_prc": 100,
"ws1_top10_prc": 0,
"ws2_top10_prc": 0,
"p_traf_prc": 0
}
],
"version": 1,
"status": 200,
"error": 0,
"error_messages": []
}API version 2.0
Метрики запросов
Формат запроса
GETзапрос
https://seowork.ru/semantics/api/v2/dashboard/query
В заголовках запроса укажите следующие параметры
Формат ответа
Объект в формате json, в котором содержится список запросов с перечеслением их свойств:
Метрики сущности за период.
Для получения информации в разрезе каждой сущности используйте следующие запросы:
Формат запроса метрик категории за период.
Формат ответа
Объект в формате json, в котором содержится список запросов с перечислением их свойств (даты будут идти друг за другом):
Формат запроса метрик группы за период.
Формат ответа
Объект в формате json, в котором содержится список запросов с перечислением их свойств (даты будут идти друг за другом):
Формат запроса метрик выборки за период.
Формат ответа
Объект в формате json, в котором содержится список запросов с перечислением их свойств (даты будут идти друг за другом):
API методы для других модулей:
Модуль Конкуренты
Модуль Отчет-Позиции