Список проектов
GET /projects
Возвращаемое значение
Параметр |
Тип |
Значение |
projects |
Структура |
Список объектов с информацией о проекте. Список сгруппирован по projectHashId
|
Пример ответа
"projects": {
"bfa46027-8485-44c6-978c-e27a6a24eab3": $projectInfo1,
"bfa46027-8485-44c6-978c-e27a6a24eab4": $projectInfo2,
"bfa46027-8485-44c6-978c-e27a6a24eab5": $projectInfo3,
}
Информация о проекте
GET /projects/{projectHashId}
Возвращаемое значение
Параметр |
Тип |
Значение |
project |
Структура |
Структура с информацией о проекте. |
Пример ответа
"project": $projectInfo
Список запросов проекта
GET /projects/{projectHashId}/requests
Возвращаемое значение
Параметр |
Тип |
Значение |
groups |
Структура |
Список объектов с информацией о группе запросов. Список сгруппирован по
groupId
|
Пример ответа
"groups": {
1: $groupInfo1,
2: $groupInfo2,
3: $groupInfo3,
}
Список поисковых систем проекта
GET /projects/{projectHashId}/engines
Возвращаемое значение
Пример ответа
"engines":[
"yandex",
"google"
]
Информация о видимости проекта
GET /projects/{projectHashId}/visibility
Входные параметры
Параметр |
Тип |
Значение |
Необязательные |
dates |
Список |
список дат в формате DDMMYYYY, разделенных запятыми.
если список пуст, считается, что нужно показать позиции за текущую дату
длина строки должна быть меньше 280 символов, что соответствует 31 дате
параметр используется только если не переданы dateFrom и dateTo
|
dateFrom |
Дата |
дата в формате DDMMYYYY
это дата начала диапазона для поиска позиций
|
dateTo |
Дата |
дата в формате DDMMYYYY
это дата окончания диапазона для поиска позиций
если параметр отсутствует, то используется текущая дата
параметр должен быть передан только вместе с dateFrom
|
Возвращаемое значение
Значения видимости проекта сгруппированные по датам (в формате DDMMYYYY) и поисковым системам
Пример ответа
{
"yandex": {
"31052021": 1,
"01062021": 2,
"02062021": 1
},
"google": {
"31052021": 1,
"01062021": 1,
"02062021": 1
}
}
Отчет по позициям
GET /projects/{projectHashId}/positions
Входные параметры
Параметр |
Тип |
Значение |
Необязательные |
dates |
Список |
список дат в формате DDMMYYYY, разделенных запятыми.
если список пуст, считается, что нужно показать позиции за текущую дату
длина строки должна быть меньше 280 символов, что соответствует 31 дате
параметр используется только если не переданы dateFrom и dateTo
|
requests |
Список |
список ID запросов, разделенных запятыми
если список пуст, позиции отдаются по всем запросам проекта
|
dateFrom |
Дата |
дата в формате DDMMYYYY
это дата начала диапазона для поиска позиций
|
dateTo |
Дата |
дата в формате DDMMYYYY
это дата окончания диапазона для поиска позиций
если параметр отсутствует, то используется текущая дата
параметр должен быть передан только вместе с dateFrom
|
Возвращаемое значение
Параметр |
Тип |
Значение |
groups |
Структура |
Список объектов с информацией о позициях
|
Пример ответа
"groups": {
164: {
"groupId":164,
"groupName":"доп группа",
"region": {
"regionId": 1,
"name": "Москва",
"number": 213,
"country": {
"countryId": 1,
"countryName": "Россия"
},
"positions": {
"1164": {
"yandex": {
"21012014": $positionInfo1,
"22012014": $positionInfo2
},
"google":{
"21012014": $positionInfo3,
"22012014": $positionInfo4
}
},
"1165": {
"yandex": {
"21012014": $positionInfo5,
"22012014": $positionInfo6
},
"google":{
"21012014": $positionInfo7,
"22012014": $positionInfo8
}
}
}
}
}
Даты парсинга позиций
GET /projects/{projectHashId}/parsingDates
Входные параметры
Параметр |
Тип |
Значение |
Необязательные |
dateFrom |
Дата |
дата в формате DDMMYYYY
в комбинации с параметром dateTo это дата начала диапазона для выборки
в комбинации с параметром count это дата для выборки дат в указанном количестве до и
после (при возможности) dateFrom, так чтобы она стремилась оказаться в "центре"
диапазона
если параметр отсутствует то используется текущая дата
|
dateTo |
Дата |
дата в формате DDMMYYYY
это дата окончания диапазона для выборки
параметр должен быть передан только вместе с dateFrom
|
count |
Число |
число дат для выборки
параметр должен быть передан только вместе с dateFrom
|
Возвращаемое значение
Параметр |
Тип |
Значение |
parsingDates |
Массив |
Список дат в формате DDMMYYYY |
Пример ответа
"parsingDates":[
"01012013",
"02012013",
"03012013",
"04012013",
]
Проект
Поле |
Тип |
Значение |
projectIdHash |
Строка |
Идентификатор проекта. |
label |
Строка |
Название проекта |
active |
Число |
Признак активности проекта: 0 - не активен, 1 - активен |
site |
Структура |
Структура с информацией о сайте, для которого производится сканирование
по позициям
|
region |
Структура |
Структура с информацией о регионе, для которого производится
сканирование по позициям
|
requestsCount |
Число |
Число запросов в проекте
|
lastParsingDates |
Список |
Список двух последних дат, в которые производился парсинг. Даты в формате DDMMYYYY
|
Пример информации о проекте
"projectIdHash": "bfa46027-8485-44c6-978c-e27a6a24eab3",
"label": "яндекс",
"active": 1,
"site": {
"siteId": 236,
"cleanDomain": "yandex.ru",
"siteUrl": "http://www.yandex.ru",
"checkSubDomain": false
},
"region": {
"regionId": 1,
"name": "Москва",
"number": 213,
"country": {
"countryId": 1,
"countryName": "Россия"
}
},
"requestsCount": 38,
"lastParsingDates": [
"20012014",
"21012014"
]
Группа запросов
Поле |
Тип |
Значение |
groupId |
Число |
ID группы |
groupName |
Строка |
Название группы |
region |
Структура |
Структура с информацией о регионе, для которого производится
сканирование по позициям |
requestList |
Список |
Список обектов с информацией о поисковом запросе |
Пример информации о группе запросов
"groupId":164,
"groupName":"доп группа",
"region": {
"regionId": 1,
"name": "Москва",
"number": 213,
"country": {
"countryId": 1,
"countryName": "Россия"
}
},
"requestList":[
{
"requestId":4761,
"requestPhrase":"seo оптимизация",
"wordStatValue":{
"generalValue":6130,
"efficiency":30,
"uniqueValue":1830,
"updateDate":"16102013"
}
},
{
"requestId":4764,
"requestPhrase":"яндекс директ",
"wordStatValue":{
"generalValue":84460,
"efficiency":45,
"uniqueValue":37733,
"updateDate":"16102013"
}
}
]
Поисковый запрос
Поле |
Тип |
Значение |
requestId |
Число |
ID поискового запроса |
requestPhrase |
Строка |
Текст запроса |
wordStatValue |
Структура |
Структура с информацией о WordStat'е |
Пример информации о запросе
"requestId":4761,
"requestPhrase":"seo оптимизация",
"wordStatValue":{
"generalValue":6130,
"efficiency":30,
"uniqueValue":1830,
"updateDate":"16102013"
}
Информация о WordStat'е
Поле |
Тип |
Значение |
generalValue |
Число |
Значение wordStat'а в обычном формате (без кавычек и восклицательного знака) |
uniqueValue |
Число |
Значение wordStat'а в точном формате (с кавычками и восклицательными знаками у каждого слова) |
efficiency |
Число |
Отношение точного значения к общему. иными словами эффективность |
updateDate |
Строка |
Дата обновления в формате DDMMYYYY |
Пример информации о WordStat'е
"generalValue":6130,
"efficiency":30,
"uniqueValue":1830,
"updateDate":"16102013"
Сайт
Поле |
Тип |
Значение |
siteId |
Число |
ID сайта |
cleanDomain |
Строка |
Доменное имя |
siteUrl |
Строка |
URL сайта
|
checkSubDomain |
Булево значение |
true - учитывать поддомены, false - строгое соответствие
|
Пример информации о сайте
"siteId": 236,
"cleanDomain": "yandex.ru",
"siteUrl": "http://www.yandex.ru",
"checkSubDomain": false
Регион
Поле |
Тип |
Значение |
regionId |
Число |
ID региона |
name |
Строка |
Название региона |
number |
Число |
Номер региона в Яндекс |
country |
Структура |
Структура с информацией о стране.
|
Пример информации о регионе
"regionId": 1,
"name": "Москва",
"number": 213,
"country": {
"countryId": 1,
"countryName": "Россия"
}
Страна
Поле |
Тип |
Значение |
countryId |
Число |
ID страны |
countryName |
Строка |
Название страны |
Пример информации о стране
"countryId": 1,
"countryName": "Россия"
Информация о позиции
Поле |
Тип |
Значение |
position |
Число |
Значение позиции в выдаче
1000 - сайт в выдаче не найден
0 - в обработке
|
page |
Структура |
Информация о релевантной странице |
Пример информации о позиции
"position":2,
"page": $pageInfo
Информация о релевантной странице
Поле |
Тип |
Значение |
page |
Строка |
адрес релевантной страницы |
Пример информации о позиции
"page": "yandex.ru/"
Поисковые системы
ID |
Описание |
yandex |
Яндекс |
google |
Google |
ID параметров домена
ID |
Описание |
cy |
ТИЦ |
pr |
PR |
yaca |
наличие в Я.Каталог |
dmoz |
наличие в Dmoz |