Открытое API SpySerp.com
Общие принципы
API доступен по ссылке https://spyserp.com/panel/api. Если в описании не указывается прямо, что используется только POST, то параметры запроса могут передаваться через метод GET.
При использовании метода POST весь массив параметров должен быть в json. При вызове любого метода отдается массив в JSON-формате. При запросе должен передаваться GET-параметр token с токеном доступа, полученным на странице профиля юзера.
При использовании метода GET название вызываемого метода API добавляется после ссылки API, например - https://spyserp.com/panel/api/keywords. Порядок передаваемых GET-параметров не имеет значения. Если в результате обработки запроса код ответа не будет равен 200, то текст ошибки будет выводится в поле status_msg
Если при вызове метода отдается массив данных с разбивкой на страницы, то параметрами для данного метода можно передавать page и pageSize - количество элементов на странице. Сервер отдает массив, в котором в элементе с ключом items лежат все данные для текущей страницы, а в элементах totalCount и page соответственно общее количество существующих элементов и текущая страница.
Если в описании параметра не указано прямо, что он обязательный - то его можно в запрос не передавать. Будет использоваться значение по умолчанию.
Общие методы
searchEngines
Пример запроса:
{
"token": "yourApiKey",
"method":"searchEngines",
"withSettingValues":1
}
Пример ответа:
{
"1": {
"id": 1,
"name": "Google",
"url": "google.com",
"type": "SE::Google",
"editable_settings": {
"google_domains": {
"result_key": "domain",
"label": "Domain",
"value": "www.google.com"
},
...
},
"setting_values": {
"google_domains": {
"values": {
"www.google.com": "www.google.com",
...
},
"long": 0
},
...
},
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех активных ПС SpySerp с параметрами
Параметры запроса:
| Параметр | Описание |
|---|---|
| withSettingValues | По умолчанию 0. Если withSettingValues = 1 В массиве для каждой ПС отдаются в поле setting_values значения для каждой настройки. Если для параметра long=1 (большое количество параметров), то значения не отдаются, а их можно получить используя метод searchEnginesLoadSettings |
Параметры ответа:
В массиве ключами элементов в корне выступают айди ПС.
| Параметр | Описание |
|---|---|
| name | Название ПС |
| url | URL ПС |
| type | Тип ПС (в Апарсере) |
| editable_settings | Редактируемые настройки ПС |
| setting_values | Опционально. Значения для каждой настройки из editable_settings, для которых long=0 |
searchEnginesLoadSettings
Пример запроса:
{
"token": "yourApiKey",
"method":"searchEnginesLoadSettings",
"key":"google_location",
"search":"Moscow"
}
Пример ответа:
{
"Moscow,Pennsylvania,United States": "Moscow,Pennsylvania,United States",
"Moscow Oblast,Russia": "Moscow Oblast,Russia",
"Moscow,Russia": "Moscow,Russia",
...
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Поиск значений для одного параметра ПС
Параметры запроса:
| Параметр | Описание |
|---|---|
| key | (Обязательный) Настройка, для которой выводятся значения |
| search | Слово, по которому ищутся существующие значения параметра |
projectFrequencyYandexConformity
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyYandexConformity"
}
Пример ответа:
{
"Freq": "Basic: apple store",
"\"Freq\"": "Phrase: \"apple store\"",
...
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Возвращает список допустимых типов соответствия для частотностей Яндекса
Методы отдельного пользователя
balance
Пример запроса:
{
"token": "yourApiKey",
"method":"balance"
}
Пример ответа:
{
"rub": 1000,
"usd": 120
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Текущий баланс пользователя по всех использованных валютах
projects
Пример запроса:
{
"token": "yourApiKey",
"method":"projects"
}
Пример ответа:
{
"groups": {
"0": {
"groupTitle": "",
"projects": [
{
"id": 21,
"name": "My project",
"created_at": 1468935137000,
"disabled": 2,
"domains": [
{
"title": "google.com",
"domain_id": 1,
"average": "0",
"top3": "0",
"top10": "0",
"top30": "0",
"up": "0",
"down": "0",
"middle": "0"
},
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех проектов пользователя, разделенных по группам
Параметры ответа:
| Параметр | Описание |
|---|---|
| groups | Массив групп проектов. Если группы пользователь не создавал, проекты размещаются в группе по умолчанию с id=0 |
| groupTitle | Название группы |
| projects | Массив проектов в группе |
| name | Название проекта |
| created_at | Временная метка создания проекта |
| disabled | Статус проекта (отключен - 1, или включен - 2) |
| domains | Массив снимка данных последнего успешно обработанного отчета проекта для каждого собственного домена проекта (average - среднее значение позиции, top3 - количество КС в топ3, top10 - количество КС в топ10, top30 - количество КС в топ30, up - количество КС, для которых позиции поднялись в сравнении с предыдущим отчетом, down - количество КС, для которых позиции упали в сравнении с предыдущим отчетом, middle - количество КС, для которых позиции не изменились в сравнении с предыдущим отчетом) |
messages
Пример запроса:
{
"token": "yourApiKey",
"method":"messages"
}
Пример ответа:
{
"items": [
{
"id": 3802,
"type": 0,
"created_at": 1510115461,
"visited_at": 0,
"subject": "Проект №1",
"content": "Парсинг завершен"
},
...
],
"totalCount": 120,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Сообщения пользователя`
Параметры запроса:
| Параметр | Описание |
|---|---|
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 300 |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | Массив сообщений |
| items.created_at | временная метка создания сообщения |
| items.visited_at | временная метка просмотра сообщения пользователем |
| items.subject | тема сообщения |
| items.content | текст сообщения |
| totalCount | Общее количество сообщений |
| page | Текущая страница |
timeline
Пример запроса:
{
"token": "yourApiKey",
"method":"timeline"
}
Пример ответа:
{
"6923": {
"project_name": "My project",
"project_id": 467,
"id": 6923,
"data": {
"up": {
"vk.com": 47
},
"vis": {
"vk.com": 169
},
"down": {
"vk.com": 83
},
"top3": {
"vk.com": 2
},
"top10": {
"vk.com": 11
},
"top30": {
"vk.com": 97
},
"middle": {
"vk.com": 39
},
"average": {
"vk.com": "30"
}
},
"time_completed": 1508713648,
"schedule_domains": [
295
]
},
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список последних распарсенных отчетов по всех проектам пользователя со снимком статистических данных
Параметры ответа:
Отдается массив с ключами id отчетов, отсортированный от новых к старым
| Параметр | Описание |
|---|---|
| project_name | название проекта |
| project_id | id проекта |
| data | массив данных снимка статистики с разбивкой по личным доменам проекта (average - среднее значение позиции, top3 - количество КС в топ3, top10 - количество КС в топ10, top30 - количество КС в топ30, up - количество КС, для которых позиции поднялись в сравнении с предыдущим отчетом, down - количество КС, для которых позиции упали в сравнении с предыдущим отчетом, middle - количество КС, для которых позиции не изменились в сравнении с предыдущим отчетом). |
| time_completed | временная метка окончания парсинга отчета |
| schedule_domains | массив id собственных доменов, для которых собиралась статистика |
package
Пример запроса:
{
"token": "yourApiKey",
"method":"package"
}
Пример ответа:
{
"package": "Expert / Эксперт",
"time_finish": "21.09.2017"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Данные о текущем пакете пользователя
Параметры ответа:
| Параметр | Описание |
|---|---|
| package | название пакета |
| time_finish | время окончания пакета |
project
Пример запроса:
{
"token": "yourApiKey",
"method":"project",
"project_id":1540,
"withSettingValues":1
}
Пример ответа:
{
"id": 21,
"name": "My project",
"created_at": 1468935137,
"disabled": 2,
"group_id": 0,
"check_type": 3,
"settings": {
"parsing_notification": {
"value": 0,
"title": "Parsing notification"
},
"openstat": {
"value": 1,
"title": "Openstat"
},
"parseAnchor": {
"value": 0,
"title": "Parse anchors and snippets"
}
}
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Просмотр данных отдельного проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| withSettings | если 1 - то дополнительно отдаются настройки проекта |
Параметры ответа:
| Параметр | Описание |
|---|---|
| name | название проекта |
| created_at | временная метка создания проекта |
| disabled | статус проекта (отключен - 1, или включен - 2) |
| group_id | id группы, к которой относится проект |
| check_type | тип запуска парсинга проекта (1 - автоматически по расписанию, 3 - вручную) |
| settings | (опционально) - текущие настройки проекта (parsing_notification - флаг отправки сообщений после окончания парсинга отчетов проекта (0 или 1),parseAnchor - флаг парсинга анкоров и сниппетов для проекта(0 и 1)) |
projectCreate
Пример запроса:
{
"token": "yourApiKey",
"method":"projectCreate",
"name":"My new project",
"group_id":2
}
Пример ответа:
{
"success": true,
"project_id": 526
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Создание проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| name | (Обязательный) имя проекта |
| group_id | по умолчанию 0. ID группы, в которую добавляется проект. Если не задано или 0 - проекту не присваивается никакая группа |
Параметры ответа:
| Параметр | Описание |
|---|---|
| project_id | id нового созданного проекта |
| error | текст ошибки если запрос не выполнен |
| existsId | В случае если проект с данным названием уже существует - в этом поле возвращается его ID |
projectDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDelete",
"project_id":526
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление проекта
projectDisable
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDisable",
"project_id":7
}
Пример ответа:
{
"success": true,
"status": 1
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение статуса проекта активный или нет.
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID проекта |
Параметры ответа:
| Параметр | Описание |
|---|---|
| status | текущий статус проекта (1 - неактивный, 2 - активный) |
projectGroupChange
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDisable",
"project_id":7,
"group_id":9
}
Пример ответа:
{
"success": true,
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение группы проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| * project_id | (Обязательный) ID |
| * group_id | (Обязательный) id новой группы |
projectRename
Пример запроса:
{
"token": "yourApiKey",
"method":"projectRename",
"project_id":448,
"name":"New project name"
}
Пример ответа:
{
"success": true,
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение группы проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID проекта |
| name | (Обязательный) Новое название проекта |
projectPasteManual
Пример запроса:
{
"token": "yourApiKey",
"method":"projectPasteManual",
"project_id":448
}
Пример ответа:
{
"success": true,
"parsed_schedule_id": 398445
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Ручное постановление проекта на парсинг
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID проекта |
projectsSettings
Пример запроса:
{
"token": "yourApiKey",
"method":"projectsSettings"
}
Пример ответа:
{
"sort_statistic": "reverse",
"show_chart": "1",
"display_number": "1",
"show_link": "1",
"display_average": "domain",
"backlight_url": "yes",
"display_statistic_numbers": "1"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение настроек всех проектов пользователя
Параметры ответа:
Ключами отдаваемого массива есть алиасы настроек, а элементами - значения этих настроек
projectsSettingsChange
Пример запроса:
{
"token": "yourApiKey",
"method":"projectsSettingsChange",
"setting":"show_chart",
"value":"0"
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение настройки всех проектов пользователя
Параметры запроса:
| Параметр | Описание |
|---|---|
| setting | (Обязательный) алиас (название) настройки |
| value | (Обязательный) новое значение настройки |
projectsSettingValues
Пример запроса:
{
"token": "yourApiKey",
"method":"projectsSettingValues",
"setting":"show_chart"
}
Пример ответа:
{
"0": "Not Show",
"1": "Show"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение возможных значений настройки всех проектов пользователя
Параметры запроса:
| Параметр | Описание |
|---|---|
| setting | (Обязательный) алиас настройки |
Параметры ответа:
Ключами в отдаваемом массиве выступают допустимые значения, а элементами - их названия
groups
Пример запроса:
{
"token": "yourApiKey",
"method":"groups"
}
Пример ответа:
{
"items": [
{
"id": 56,
"name": "Group 1",
"projectscount": 1
},
{
"id": 43,
"name": "Bad projects",
"projectscount": 9
},
...
],
"totalCount": 11,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех групп проектов пользователя
Параметры запроса:
| Параметр | Описание |
|---|---|
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 20 |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | Массив групп пользователя |
| items.name | название группы |
| items.projectscount | количество проектов в группе |
| totalCount | Общее количество групп |
| page | Текущая страница |
groupAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"groupAdd",
"group":"New group"
}
Пример ответа:
{
"success": true,
"id": 73
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление группы
Параметры запроса:
| Параметр | Описание |
|---|---|
| group | (Обязательный) название новой группы |
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | id новой группы |
groupDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"groupAdd",
"groupId":73
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление группы
Параметры запроса:
| Параметр | Описание |
|---|---|
| groupId | (Обязательный) ID группы |
groupUpdate
Пример запроса:
{
"token": "yourApiKey",
"method":"groupAdd",
"groupId":73,
"groupName":"New group name"
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение названия группы
Параметры запроса:
| Параметр | Описание |
|---|---|
| groupId | (Обязательный) ID группы |
| groupName | (Обязательный) новое имя группы |
limits
Пример запроса:
{
"token": "yourApiKey",
"method":"limits"
}
Пример ответа:
{
"limits": {
"project": {
"value": 10000000,
"title": "Projects",
"currentValue": 99
}
},
"projectLimits": {
"search_engine": {
"value": 20,
"title": "Search engines/project",
"projectValues": {
"2": 2,
...
}
},
"keyword": {
"value": 10000000,
"title": "Keywords/project",
"projectValues": {
"2": 250,
...
}
},
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех лимитов пользователя
Параметры ответа:
| Параметр | Описание |
|---|---|
| limits | массив общих лимитов |
| limits.project | "project" алиас лимита, в массиве - его данные, где value - значение лимита, currentValue - текущее значение по этому лимиту (сколько действительно на данный момент проектов у пользователя) |
| projectLimits | массив лимитов проектов. В данном массиве ключами выступают алиасы лимитов, а в массивах - данные по каждому лимиту, где: value - значение лимита, title - его название, projectValues - текущие значения лимита для каждого проекта (например, keyword.projectValues: {"2": 1663} означает, что сейчас в проекте с id 2 есть 250 КС |
limit
Пример запроса:
{
"token": "yourApiKey",
"method":"limit",
"limit":"project",
"project_id":7
}
Пример ответа:
{
"limit": 100,
"currentValue": 99
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Данные по отдельному лимиту
Параметры запроса:
| Параметр | Описание |
|---|---|
| limit | (Обязательный) алиас лимита |
| project_id | если указано, то выводятся значения лимита по выбранному проекту |
Параметры ответа:
| Параметр | Описание |
|---|---|
| limit | Значение лимита пользователя |
| currentValue | текущее значение показателя по этому проекту |
sharedProjects
Пример запроса:
{
"token": "yourApiKey",
"method":"sharedProjects"
}
Пример ответа:
[
{
"id": 18,
"name": "Some Project"
},
...
]
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех открытых для пользователя проектов
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | ID открытого для текущего пользователя проекта |
| name | Название открытого для текущего пользователя проекта |
Проект - статистика
statistic
Пример запроса:
{
"token": "yourApiKey",
"method":"statistic",
"project_id": 7,
"domain": 5,
"withLinks":1,
"withAnchors":1,
"withSnippets":1
}
Пример ответа:
{
"7330": [ // Данные отчета с id = 7330
{
"domain": "lenta.ru",
"domain_id": 5,
"data": [ // Данные домена lenta.ru
{
"category": "Main",
"category_id": 490,
"data": [ // Данные категории Main
{
"keyword": "лента",
"key_id": 78619,
"data": { // Данные ключевого слова "лента"
"858": [ // Данные ПС
1, // Позиция
"https://lenta.ru/", // Ссылка для данной позиции
"«<b>Lenta</b>.ru» — интернет-газета - <b>Москва</b>", // Анкор
"Российские и международные новости и события в сфере политики, <wbr/>экономики, науки и техники, культуры, спорта. Инфографика. <wbr/>Фотогалерея.<b>", // Сниппет
1 // Флаг состояния возможности просмотра выдачи по позиции
],
...
},
},
...
],
},
...
],
},
],
...
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Возвращает массив данных статистики проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID проекта |
| domain | (Обязательный) ID домена |
| se | ID ПС или 0 если все. (По умолчанию - все ПС) |
| show | Флаг отображения КС с позициями ('position'), или без ('all') |
| start_date | Временная метка начала интервала, в котором должны находиться отчеты, выбираемые для построения массива статистики |
| end_date | Временная метка окончания интервала, в котором должны находиться отчеты, выбираемые для построения массива статистики |
| schedules | Строка ID отчетов, разделенных через запятую - если параметр указан, то будут выбираться только данные отчеты. Если нет - отображаются последние отчеты |
| category | ID категории или -1 если все. (По умолчанию - все ПС) |
| search | Строка для поиска по названиям КС |
| page | Страница для пагинации по отчетам (по умолчанию - 0) |
| top | Выборка КС только с позициями выше указанного значения. Возможные варианты - 3, 10, 30, 'all' (по умолчанию - 'all') |
| sort | Флаг для сортировки КС по определенных значениях (по умолчанию - сортировка по названию КС). Возможные варианты - 1(A-Z - сортировка по названию КС), 2(1-100 - сортировка по наивысшей позиции КС, от высших к низшим), 3(100-1 - сортировка по наивысшей позиции КС, от низшим к высшим) |
| withcat | Отображение КС с указанием категорий (0) или без (1) |
| keyPage | Страница для пагинации по КС - работает только тогда, когда в настройках выбрано отображение только одного домена |
| withLinks | Флаг для отображения ссылок в массиве статистики |
| withAnchors | Флаг для отображения анкоров в массиве статистики |
| withSnippets | Флаг для отображения сниппетов в массиве статистики |
| externalDomain | ID домена для вывода статистики по домену, не входящему в список доменов проекта |
Параметры ответа:
Отдается массив данных с ключами - id выбранных отчетов. Каждый массив одного отчета, разбитый на домены, дальше - на категории, категории разбиваются на ключевые слова, а ключевые слова - на ПС, для которых выводится массив значений - позиция, ссылка, анкор, сниппет и флаг состояния просмотра выдачи ПС
Проект - ключевые слова
projectKeywords
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywords",
"project_id":7,
"withColumns":1,
"category_id":1
}
Пример ответа:
{
"items": [
{
"key_id": 2046015,
"key": "some keyword",
"category_id": 1,
"columnData": {
"2": {
"1": "https://www.google.com/maps/d/viewer?usp=sharing&mid=1gkXz6JI-kyeMa7ZHGlKBB4mIu9w",
"5": "",
"253": "https://www.youtube.com/playlist?list=PLC7_RzojUnJcKwuiOSyjNvuB9WkQrGlEl",
"1983720": ""
},
"25": "some value"
}
},
...
],
"totalCount": 3,
"page": 1
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Возвращает КС проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 300 |
| withColumns | по умолчанию 0, если 1 - будут отдаваться КС со значениями всех колонок |
| category_id | сли указано - будут отдаваться только КС, которые относятся к указанной категории, передаваться может число или массив чисел |
| key_ids | если указано - будут отдаваться КС c id, которые есть в данном массиве (поиск КС по id) |
| search | поиск КС по названию |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | массив КС. В нем: key_id - id КС, key - КС, category_id - категория, к которой относится КС, columnData - (опционально) данные колонок для этого КС. В массиве columnData ключами элементов выступают id колонок, а сами элементы - это значения колонок для данного КС. Если id колонки = 2 (Колонка релевант УРЛ), то значением будет массив, где ключами выступают id доменов, а элементами - релевантные ссылки. |
| totalCount | общее число КС для полученных настроек. |
| page | текущая страница |
projectKeywordsAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsAdd",
"project_id":7,
"category_id":1,
"keywords":[
"Новое ключевое слово",
"Еще одно ключевое слово"
]
}
Пример ответа:
{
"success": true,
"added": 2,
"ids": [
2048334,
2048335
],
"exist": []
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление КС проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| keywords | (Обязательный) массив добавляемых КС в виде массива строчек, не более 1000 КС в массиве |
| category_id | Если указано - все КС сохраняются в выбранную категорию, если нет - в категорию по умолчанию |
| skipFailed | Если указано 1, то при нахождении в массиве КС ошибочных названий они будут пропускаться, а не будет выводится ошибка. По умолчанию - выводится ошибка |
Параметры ответа:
| Параметр | Описание |
|---|---|
| added | количество добавленных КС |
| ids | id добавленных КС |
| exist | массив существующих в проекте КС (если в списке добавляемых есть КС, которые уже есть в проекте) |
projectKeywordsAddWithColumns
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsAddWithColumns",
"project_id": 1393,
"skipFailed": true,
"keywords": [
{
"name": "some added keyword", // Добавляемое ключевое слово
"categoryId": 4631, // ID категории в которую добавляется КС, если не указано - КС будет добавлятся в дефолтную категорию
"columns": {
"299": "12345", // Добавляется значение 12345 в колонку с ID=299
"2": { // ID колонки релевантных урл - одинаковое для всех проектов
"1": "http://google.com/" // Добавляется релевантный урл для домена с ID=1
}
}
},
...
]
}
Пример ответа:
{
"success": true,
"added": 2,
"ids": {
"some added keyword": 123456,
...
},
"exist": [
"some exists keyword",
...
]
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление КС проекта со значениями колонок
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| items | (Обязательный) массив добавляемых КС в виде обьекта. Для каждого элемента обыязательно наличие элемента name, |
| items.name | Добавляемое ключевое слово |
| items.categoryId | ID категории в которую добавляется КС, если не указано - КС будет добавлятся в дефолтную категорию |
| items.columns | Массив значений колонок что добавляются для ключевого слова. Для того чтобы добавить значение колонки для ключевого слова - колонка уже должна быть добавленой в проект |
Параметры ответа:
| Параметр | Описание |
|---|---|
| added | количество добавленных КС |
| ids | id добавленных КС |
| exist | массив существующих в проекте КС (если в списке добавляемых есть КС, которые уже есть в проекте) |
projectKeywordsDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsDelete",
"project_id":7,
"keyword_ids":[
2048334,
2048335
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление КС проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| keyword_ids | (Обязательный) массив айди КС для удаления |
projectKeywordsChangeCategory
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsChangeCategory",
"project_id":241,
"keyword_ids":[
2046015
],
"category_id": 298
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение категории КС
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| category_id | (Обязательный) Category ID |
| keyword_ids | (Обязательный) массив айди КС - key_id из КС по методу projectKeywords |
projectKeywordsColumnsEdit
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsColumnsEdit",
"project_id":241,
"keywords":[
{
"keyword_id":80509,
"column_id":25,
"value":123
},
{
"keyword_id":2046015,
"column_id":2,
"domain_id":4,
"value":"http://yandex.ru/testPage"
}
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение значение колонок КС (лимит - не больше 300 элементов в массиве КС)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| keywords | (Обязательный) массив КС со значениями колонок. Обязательно наличие полей 'column_id', 'keyword_id', 'value', если изменяется колонка релевант урл - то еще и поле domain_id |
projectKeywordsRename
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsRename",
"project_id":7,
"keywords":[
{
"key_id":2046015,
"keyword":"Новое ключевое слово"
}
]
}
Пример ответа:
{
"success": true,
"renamed": {
"Новое ключевое слово": 2048336
}
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Переименование КС проекта. При переименовании КС данные КС сохраняются - категория, значения колонок. (лимит - не больше 100 КС на переименование)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| keywords | (Обязательный) массив КС для переименования - в нем обязательно существование ключей key_id и keyword (новое название КС) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| renamed | массив переименованных КС, где ключом выступает новое название КС, а элементом - его id |
projectKeywordsDeleteAll
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsDeleteAll"
}
Пример ответа:
{
"success": true,
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
projectKeywordsPick
Пример запроса:
{
"token": "yourApiKey",
"method":"projectKeywordsPick",
"project_id": 7,
"key":"283",
"schedule_id":7267,
"se":39
}
Пример ответа:
[
"http://korrespondent.net/",
"http://news.bigmir.net/",
"https://www.obozrevatel.com/",
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Отдает список всех ссылок, полученных для определенного КС, ПС и отчета
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| key | (Обязательный) ID ключевого слова |
| schedule_id | (Обязательный) ID отчета |
| se | (Обязательный) id ПС проекта |
Проект - домены
projectDomains
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDomains",
"project_id":7,
"type":1
}
Пример ответа:
{
"items": [
{
"rel_id": 1501,
"domain_id": 5,
"is_own": 1,
"domain": "lenta.ru"
},
...
],
"totalCount": 2,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех доменов проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 100 |
| type | (если не указан, отдаются все домены) - фильтр по типу домена - свой домен (1) или домен-конкурент (0) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | массив доменов. В нем: domain_id - id домена, rel_id - id связи домен-проект, is_own - тип домена (1 - свой домен, 0 - домен-конкурент), domain - название домена |
| totalCount | общее количество доменов по полученным настройкам |
| page | Текущая страница |
projectDomainsAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDomainsAdd",
"project_id":7,
"domains": [
{
"domain":"яндекс.ру",
"is_own":1
}
]
}
Пример ответа:
{
"success": true,
"added": {
"яндекс.ру": 1983720
}
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление доменов проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| domains | (Обязательный) массив добавляемых доменов. Для каждого элемента массива должны быть указаны поля: domain - название добавляемого домена, is_own - свой домен (1) или домен-конкурент (0) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| added | массив добавленных доменов, где ключом является добавленный домен, а элементом - его id |
projectDomainsDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDomainsDelete",
"project_id":7,
"domain_ids": [
1983720
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление доменов проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| domain_ids | (Обязательный) массив id удаляемых доменов |
projectDomainsChangeType
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDomainsChangeType",
"project_id":7,
"domain_ids":[
5
],
"type":1
}
Пример ответа:
{
"success": true,
"changed_domains": {
"5": 1
}
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Изменение типа домена
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| domain_ids | (Обязательный) массив айди доменов |
| type | если указан, то для всех доменов выставляется данный тип |
Параметры ответа:
| Параметр | Описание |
|---|---|
| changed_domains | массив обработанных доменов, где ключом выступает id домена, а значением - текущий тип (1 - собственный домен, 0 - домен-конкурент) |
projectDomainsCollect
Пример запроса:
{
"token": "yourApiKey",
"method":"projectDomainsCollect",
"project_id":7
}
Пример ответа:
[
"vk.com",
"yandex.ru",
"ok.ru",
"24tv.ua",
"news.yandex.ru",
"ru.wikipedia.org",
"korrespondent.net",
"books.google.com",
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Отдает 30 наиболее часто встречающихся доменов из статистики
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Проект - поисковые системы
projectSearchEngines
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSearchEngines",
"project_id":7
}
Пример ответа:
{
"16": {
"short": "G1",
"name": "Google",
"settings": "(www.google.com, Dutch, English, Russia)",
"settingsArray": {
"google_domains": {
"display": "www.google.com",
"value": "www.google.com",
"id": 1
},
...
},
"se_id": 1
},
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение всех активных ПС проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
Отдается массив, где ключами выступают id ПС проекта. В каждом элементе: short - сокращенное название ПС, name - название ПС, settings - совокупность текущих настроек строкой, settingsArray - массив текущих значений настроек ПС, se_id - глобальный id поисковой системы в SpySerp
projectSearchEngine
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSearchEngines",
"project_id":7,
"project_se_id":16
}
Пример ответа:
{
"short": "Y1",
"name": "Yandex",
"settings": "(---Ярославль)",
"settingsArray": {
"yandex_regions": {
"display": "---Ярославль",
"value": "16",
"id": 592
}
},
"project_se_id": 3
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение ПС проекта по ее ID
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| project_se_id | (Обязательный) ID ПС проекта |
Параметры ответа:
| Параметр | Описание |
|---|---|
| short | сокращенное название ПС |
| name | название ПС |
| settings | совокупность текущих настроек строкой |
| settingsArray | массив текущих значений настроек ПС |
| se_id | глобальный id поисковой системы в SpySerp |
projectSearchEnginesAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSearchEnginesAdd",
"project_id": 7,
"engines":[
{
"se_id":1,
"settings":{
"google_langs":"lang_ru",
"google_location":"",
"google_domains":"www.google.com",
"google_hl":"en",
"google_country_codes":"RU"
}
}
]
}
Пример ответа:
{
"success": true,
"added": [
855
]
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление в проект ПС
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| engines | (Обязательный) массив добавляемых ПС, в каждом элементе массива должен быть элемент se_id - айди добавляемой ПС, и settings - массив настроек (например "google_langs":"lang_ru"). |
Параметры ответа:
| Параметр | Описание |
|---|---|
| added | массив id добавленных ПС |
projectSearchEnginesEdit
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSearchEnginesEdit",
"project_id": 7,
"engine_id":803,
"settings":{
"google_langs":"lang_ru",
"google_location":"",
"google_domains":"www.google.ru",
"google_hl":"en",
"google_country_codes":"RU"
}
}
Пример ответа:
{
"success": true,
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление в проект ПС
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| engine_id | (Обязательный) Engine ID |
| settings | (Обязательный) массив всех новых настроек ПС ПС |
projectSearchEnginesDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSearchEnginesDelete",
"project_id": 7,
"relation_id": 855
}
Пример ответа:
{
"success": true,
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление ПС из проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| relation_id | (Обязательный) id ПС проекта, которая удаляется |
Проект - категории
projectCategories
Список категорий проекта
Пример запроса:
{
"token": "yourApiKey",
"method":"projectCategories",
"project_id":7
}
Пример ответа:
{
"items": [
{
"id": 490,
"title": "Main",
"keysCount": 8,
"default": 1,
"keyPagesCount": 1
},
...
],
"totalCount": 2,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | Page |
| pageSize | Page size. Не больше 100 |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | |
| items.id | ID категории |
| items.title | название категории |
| items.keysCount | количество КС в данной категории |
| items.default | является ли эта категория категорией по умолчанию (1 - да, 0 - нет) |
| totalCount | общее количество категорий |
| page | текущая страница |
projectCategoriesAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectCategoriesAdd",
"project_id":7,
"categories":[
"New category"
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление категорий к проекту
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| categories | (Обязательный) массив названий новых категорий |
projectCategoriesDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectCategoriesDelete",
"project_id":7,
"category_ids":[
486
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление категории проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| category_ids | (Обязательный) массив айди категорий для удаления |
projectCategoriesEdit
Пример запроса:
{
"token": "yourApiKey",
"method":"projectCategoriesEdit",
"project_id": 7,
"category_id": 190,
"category": "Edited second test category"
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Редактирование названия категории проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| * project_id | (Обязательный) ID |
| * category_id | (Обязательный) айди редактируемой категории |
| * category | (Обязательный) новое название категории |
| * default_category | 1 или 0 |
Проект - расписания
projectAutoSchedules
Пример запроса:
{
"token": "yourApiKey",
"method":"projectAutoSchedules",
"project_id":7
}
Пример ответа:
{
"success": true,
"items": [
{
"id": 123456,
"days": [
1,
7
],
"time": "15:00",
"enabled": true
},
...
]
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех расписаний проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | Массив расписаний проекта. В каждом элементе: id - ID расписания, days - массив дней недели когда будет срабатывать автозапуск проекта - от 1 до 7 (понедельник - воскресенье), time - время когда будет срабатывать расписание (с учетом временной зоны пользователя), enabled - флаг активировано ли расписание (если false - проект не будет запускатся по этому расписанию) |
projectAutoSchedulesAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectAutoSchedulesAdd",
"project_id":123456,
"items": [
{
"days":[1,2,3,4,5,6],
"time":"15:30",
"enabled": true
},
...
]
}
Пример ответа:
{
"success": true,
"items": [
{
"id": 123456
},
...
]
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление расписаний проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| items | Массив новых расписаний проекта. В каждом элементе: days - массив дней недели когда будет срабатывать автозапуск проекта - от 1 до 7 (понедельник - воскресенье), time - время когда будет срабатывать расписание (с учетом временной зоны пользователя, передавать в формате "HH:mm", в минутах может быть только "00" или "30", в часах - от "00" до "23"), enabled (true/false) - флаг активировано ли расписание (если false - проект не будет запускатся п оэтому расписанию) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | Массив айди добавленных расписаний проекта. В каждом элементе: id - ID расписания |
projectAutoSchedulesUpdate
Пример запроса:
{
"token": "yourApiKey",
"method":"projectAutoSchedulesUpdate",
"project_id":12345,
"items": [
{
"id":12345,
"time":"10:00"
},
...
]
}
Пример ответа:
{
"success": true,
"items": [
{
"id": 12345,
"days": [
1,
2,
3,
4,
5,
6
],
"time": "10:00",
"enabled": true
},
...
]
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Реактирование настроек расписаний проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| items | Массив настроек для обновления расписаний проекта. В каждом элементе обязательно наличие элемента id и возможно наличие таких параметров: days - массив дней недели когда будет срабатывать автозапуск проекта - от 1 до 7 (понедельник - воскресенье), time - время когда будет срабатывать расписание (с учетом временной зоны пользователя, передавать в формате "HH:mm", в минутах может быть только "00" или "30", в часах - от "00" до "23"), enabled (true/false) - флаг активировано ли расписание (если false - проект не будет запускатся по этому расписанию) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | Массив всех настроек обновленных расписаний проекта. В каждом элементе отдаются поля id, days, time и enabled |
projectAutoSchedulesRemove
Пример запроса:
{
"token": "yourApiKey",
"method":"projectAutoSchedulesRemove",
"project_id":12345,
"items": [
{
"id":12345
},
...
]
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление расписаний проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| items | Массив id авторасписаний для удаления |
Проект - колонки
projectColumns
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumns",
"project_id":7,
"withFilled":1
}
Пример ответа:
{
"items": [
{
"id": 245,
"type_id": 0,
"description": "Some column",
"hide": false,
"region": false,
"freq_type": false,
"conformity": false,
"deleted": false,
"column_type": "common",
"filled": 0
},
...
],
"totalCount": 2,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех колонок проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 100 |
| withFilled | дополнительно отдает для каждой колонки поле filled с количеством заполненных значений колонки для всех КС проекта, |
Параметры ответа:
items | Массив колонок проекта. В каждом элементе: id - ID колонки, type_id - тип колонки (0 - число, 1 - строка. Используется при сортировке статистики по колонке), description - название колонки, hide - флаг, скрыта или нет колонка на странице статистики, region - id региона, если колонка - частотность яндекса, freq_type - 1, если колонка частотности, conformity - тип соответствия, если колонка частотности яндекса, deleted - флаг, удалена ли колонка, column_type - тип колонки, filled - (опционально) количество КС из заполненными значениями для этой колонки totalCount | общее количество колонок page | текущая страница
projectColumnsAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsAdd",
"project_id":7,
"column": {
"description": "Some column",
"type_id":0
}
}
Пример ответа:
{
"success": true,
"columnId": 245
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление колонки в проект
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| column | (Обязательный) если в поле передается число, то ищется колонка с данным айди среди доступных колонок для добавления - получаются отдельно методом projectColumnsAvailable. Если в поле передается массив, то добавляется новая колонка, заполненная параметрами из массива. Обязательными элементами массива в этом случае есть 'description', 'type_id'(тип колонки. 0 - числовой, 1 - строчный) |
Параметры ответа:
| Параметр | Описание |
|---|---|
| columnId | id добавленной колонки |
projectColumnsAvailable
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsAvailable",
"project_id":7
}
Пример ответа:
[
{
"id": 2,
"description": "Relevant URL",
"type": "Inbuilt column"
},
{
"id": 169,
"description": "ewrewrewrew ewr er ewrewrewrewrewrewrewr",
"type": "Own column"
},
...
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список всех доступных для добавления колонок проекта (встроенных колонок, или тех колонок, которые есть в других проектах пользователя)`
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
Массив существующих доступных для добавления колонок.
| Параметр | Описание |
|---|---|
| description | Описание колонки |
| type | тип колонки("Inbuilt column" встроенная колонка, доступная для добавления любым пользователем, "Own column" - колонка, существующая в одном из других проектов пользователя) |
projectColumnsDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsDelete",
"project_id":7,
"column_id":2
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление колонки из проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| column_id | (Обязательный) id колонки, которая удаляется |
projectColumnsEdit
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsEdit",
"project_id":7,
"column_id":25,
"column": {
"description": "Some column",
"type_id":0
}
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Редактирование личной колонки (нельзя редактировать колонку релевант урл или частотности)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| column_id | (Обязательный) Column ID |
| column | (Обязательный) в поле передается массив. Обязательными элементами массива есть 'description', 'type_id'(тип колонки. 0 - числовой, 1 - строчный) |
projectColumnsHide
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsHide",
"project_id":7,
"column_id":78
}
Пример ответа:
{
"success": true,
"hide": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Скрытие колонки на странице статистики. Возвращает hide - текущее значение true/false
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| column_id | (Обязательный) Column Id |
Параметры ответа:
Возвращает hide - текущее значение true/false
projectColumnsAutocollect
Пример запроса:
{
"token": "yourApiKey",
"method":"projectColumnsAutocollect",
"project_id":7,
"column_id":78
}
Пример ответа:
{
"success": true,
"msg": "Task added successfully"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Автоматический сбор линков для колонки релевант урл из существующей статистики, или автоматический запуск тасков для сбора значений для колонок частотности (если переданный column_id принадлежит колонке частотности)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| column_id | (Обязательный) Column ID |
Проект - частотности
projectFrequencyYandexRun
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyYandexRun",
"project_id": 7,
"conformities":["Freq"],
"category":-1
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Запуск сбора частотностей
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| conformities | (Обязательный) массив id типов соответствия Яндекса |
| category | (Обязательный) id категории, если нужно собирать частотности только для КС с определенной категории, если -1 - то для всех категорий |
| skipExist | флаг - пропускать ли существующие значения частотностей или нет |
| regions | массив id регионов Яндекса |
projectFrequencyColumns
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyColumns",
"project_id": 7
}
Пример ответа:
{
"existFrequencies": {
"109": {
"freq_type": 1,
"conformity": "Freq",
"region": "213",
"queriesDoneCount": 17,
"columnId": 109,
"category": "-1",
"timeStart": 1498910291,
"skipOnExist": true,
"hide": true,
"description": "Frequency Yandex частотность(---Москва, Freq)",
"existsCount": 0
}
},
"keywordsCount": "45"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение списка колонок частотности с дополнительными параметрами
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| existFrequencies | массив колонок частотностей. В данном массиве ключами элементов есть id колонки, а значением - массив с такими составляющими: freq_type - тип частотности (1 - Яндекс-частотность), conformity - тип соответствия для Яндекса, region - id региона для Яндекса, queriesDoneCount - количество КС, запрошенных для последнего таска по этой колонке, category - если -1, то частотность последнего успешно завершенного таска снималась для всех КС, а если указано число - то только для категории с id = category, timeStart - начало сбора частотностей, skipOnExist - флаг таска, если 1 - то при сборе пропускались существующие значения частотности, hide - скрывается или нет колонка на странице статистики, description - описание колонки, existsCount - количество КС, для которых собраны значения колонки. |
| keywordsCount | количество КС в проекте |
projectFrequencyYandexRegions
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyYandexRegions",
"project_id": 21
}
Пример ответа:
{
"1": "--Москва и область",
"217": "---Пущино",
"10716": "---Балашиха"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение списка регионов Яндекса проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
Отдается массив регионов Яндекса для проекта, где ключом есть id региона, а значением - его название
projectFrequencyYandexRegionsDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyYandexRegionsDelete",
"project_id": 21,
"region_id":217
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление региона Яндекса из списка регионов проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| region_id | (Обязательный) ID региона, который удаляется |
projectFrequencyYandexRegionsAdd
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyYandexRegionsAdd",
"project_id": 7,
"region_id":10741
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Добавление региона Яндекса в список регионов проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| region_id | (Обязательный) Region ID |
projectFrequencyTasks
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyTasks",
"project_id": 7
}
Пример ответа:
[
"items": [
{
"id": 1046,
"time_created": 1508242196,
"time_completed": 1508242203,
"status": 4,
"progress": 100,
"task_config": {
"region": "10719",
"category": "-1",
"columnId": 114,
"freq_type": "1",
"conformity": "Freq",
"skipOnExist": false
}
},
...
],
"totalCount": 2,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список тасков сбора частотностей для колонок. Сортируется от новых к старым
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | Page |
| pageSize | Page Size. Не больше 100 |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | массив тасков, в котором: id - ID таска, time_created - временная метка запуска таска, time_completed - временная метка запуска таска, status - статус (4 - успешно завершен), progress - прогрес сбора в процентах, task_config - настройки таска, где: region - id региона Яндекса, category - id категории или -1 если для всех категорий, columnId - id колонки, для которой собираются значения, freq_type - тип частотности (1 - Яндекс), conformity -тип соответствия Яндекс-частотности, skipOnExist - пропускать ли сбор для КС и колонки, если значение уже существует |
| totalCount | Общее количество элементов |
| page | Текущая страница |
projectFrequencyTable
Пример запроса:
{
"token": "yourApiKey",
"method":"projectFrequencyTable",
"project_id": 7
}
Пример ответа:
[
"items": {
"982": {
"78": 0,
"80": 0,
"82": 0,
"84": 0,
"109": "15",
"110": 13,
"111": 13,
"112": 6,
"113": 6,
"120": 0
},
...
],
"totalCount": 120,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Данные колонок частотности для всех КС проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | Page |
| pageSize | Page Size. Не больше 100 |
| sc | Вид сортировки. По умолчанию = sc='key', если указань айди колонки - сортировка будет проводится по значениям выбранной колонки |
| sort_type | Порядок сортировки - asc или desc |
| category | ID категории - если параметр указан, будут выводится только данные для КС что относятся к указанной категории |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | массив КС, где ключем выступает ID КС а в значении - массив значений колонок частотностей (id колонки => значение) |
| totalCount | Общее количество элементов |
| page | Текущая страница |
Проект - открытый доступ
projectSharedEmails
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSharedEmails",
"project_id": 7
}
Пример ответа:
{
"8": "test@test.com"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение списка емейлов, для которых проект открыт
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
Отдается массив, где ключами выступают id пользователя, а элементами - его е-мейл
projectSharedUrlCreate
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSharedUrlCreate",
"project_id": 7
}
Пример ответа:
{
"success": true,
"publicUrl": "http://spyserp.com/share?id=228acc8d060e8f7faa4de05bd93eb2ca"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Открытие доступа к проекту для незарегистрированных юзеров по ссылке - ссылка возвращается в ответе. Этот метод заново создает и сохраняет ссылку.
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| publicUrl | ссылка для публичного доступа к проекту |
projectSharedUrlGet
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSharedUrlGet",
"project_id": 7
}
Пример ответа:
{
"publicUrl": "http://spyserp.com/share?id=228acc8d060e8f7faa4de05bd93eb2ca"
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение ссылки на открытый для публичного доступа проект
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| publicUrl | ссылка для публичного доступа к проекту |
projectSharedUser
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSharedUser",
"project_id": 7,
"email":"test@spyserp.com"
}
Пример ответа:
{
"success": true,
"users": {
"5": "test@spyserp.com",
"8": "test@test.com"
}
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Открытие доступа к проекту для отдельного пользователя по емейлу
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| (Обязательный) Email |
Параметры ответа:
| Параметр | Описание |
|---|---|
| users | массив всех пользователей, для которых на данный момент открыт доступ к проекту |
projectSharedUserDelete
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSharedUserDelete",
"project_id": 7,
"user_id":5
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Удаление юзера из списка, для которых открыт доступ к проекту
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| user_id | (Обязательный) User ID |
Проект - разные методы
projectSchedules
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSchedules",
"project_id":7
}
Пример ответа:
{
"items": [
{
"id": 245,
"type_id": 0,
"description": "Some column",
"hide": false,
"region": false,
"freq_type": false,
"conformity": false,
"deleted": false,
"column_type": "common",
"filled": 0
},
...
],
"totalCount": 2,
"page": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Список отчетов проекта. От новых к старым
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| page | по умолчанию 0 |
| pageSize | по умолчанию 20. Не больше 100 |
Параметры ответа:
| Параметр | Описание |
|---|---|
| items | массив отчетов. time_created - временная метка создания отчета, time_started- временная метка запуска отчета, time_completed - временная метка завершения парсинга отчета, time_parse - массив с временем парсинга отчета, status - статус отчета (4 - завершен успешно), type - тип запуска отчета - вручную или автоматически, progress - показатель завершения отчета в процентах, data - снимок статистических данных отчета, parseData - количества распарсенных КС. |
| totalCount | общее количество колонок |
| page | текущая страница |
projectSchedule
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSchedule",
"project_id":7,
"schedule_id":6975
}
Пример ответа:
{
"id": 6926,
"time_created": 1508740200,
"time_started": 1508740201,
"time_completed": 1508741392,
"time_parse": {
"parsing": 1189,
"saving": 2.0652
},
"status": 4,
"type": 1,
"progress": 100,
"data": {
"up": {
"253": 50
},
...
},
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Данные отдельного отчета проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| schedule_id | (Обязательный) ID отчета для которого будут отдаваться данные |
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | ID отчета |
| time_created | временная метка создания отчета, |
| time_started | временная метка запуска отчета, |
| time_completed | временная метка завершения парсинга отчета, |
| time_parse | массив с временем парсинга отчета, |
| status | статус отчета (4 - завершен успешно), |
| type | тип запуска отчета - вручную или автоматически, |
| progress | показатель завершения отчета в процентах, |
| data | снимок статистических данных отчета, |
| parseData | количества распарсенных КС. |
projectLastSchedule
Пример запроса:
{
"token": "yourApiKey",
"method":"projectLastSchedule",
"project_id":7
}
Пример ответа:
{
"id": 6926,
"time_created": 1508740200,
"time_started": 1508740201,
"time_completed": 1508741392,
"time_parse": {
"parsing": 1189,
"saving": 2.0652
},
"status": 4,
"type": 1,
"progress": 100,
"data": {
"up": {
"253": 50
},
...
},
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Данные последнего успешного отчета проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | ID отчета |
| time_created | временная метка создания отчета, |
| time_started | временная метка запуска отчета, |
| time_completed | временная метка завершения парсинга отчета, |
| time_parse | массив с временем парсинга отчета, |
| status | статус отчета (4 - завершен успешно), |
| type | тип запуска отчета - вручную или автоматически, |
| progress | показатель завершения отчета в процентах, |
| data | снимок статистических данных отчета, |
| parseData | количества распарсенных КС. |
projectActiveSchedule
Пример запроса:
{
"token": "yourApiKey",
"method":"projectActiveSchedule",
"project_id":7
}
Пример ответа:
{
"id": 6990,
"time_created": 1508942051,
"progress": 0
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Получение активного отчета (что парсится на данный момент)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | ID отчета, который сейчас обрабатывается |
| time_created | временная метка создания отчета |
| progress | прогресс парсинга в процентах |
projectActiveTasks
Пример запроса:
{
"token": "yourApiKey",
"method":"projectActiveTasks",
"project_id":7
}
Пример ответа:
[
{
"id": 1748,
"time_created": 1508942611,
"progress": 0,
"task_config": {
"region": "213",
"category": -1,
"columnId": 112,
"freq_type": "1",
"conformity": "\"[Freq]\"",
"skipOnExist": true
}
},
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
получение активных тасков (для частотностей)
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
Параметры ответа:
| Параметр | Описание |
|---|---|
| id | ID отчета, который сейчас обрабатывается |
| time_created | временная метка создания отчета |
| progress | прогресс парсинга в процентах |
| task_config | настройки таска перед запуском |
projectSaveSetting
Пример запроса:
{
"token": "yourApiKey",
"method":"projectSaveSetting",
"project_id": 21,
"setting":"parseAnchor",
"value":0
}
Пример ответа:
{
"success": true
}
Убедитесь, что Вы заменили "yourApiKey" на свой АПИ токен!
Сохранение отдельной настройки проекта
Параметры запроса:
| Параметр | Описание |
|---|---|
| project_id | (Обязательный) ID |
| setting | (Обязательный) алиас настройки |
| value | (Обязательный) новое значение настройки |
Errors
The Kittn API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The kitten requested is hidden for administrators only. |
| 404 | Not Found -- The specified kitten could not be found. |
| 405 | Method Not Allowed -- You tried to access a kitten with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The kitten requested has been removed from our servers. |
| 418 | I'm a teapot. |
| 422 | Unprocessable Entity. Bad some of request params. |
| 429 | Too Many Requests -- You're requesting too many kittens! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
