Справочная система

Содержание справки
 

GetProjectParams
Получение полной информации о проекте, включая данные актуальной (либо по указанной дате) проверки и предыдущей проверки, для сравнения динамики изменения позиций. Чтобы минимизировать объем передаваемых данных и ускорить их загрузку, предусмотрена возможность отключить получение отдельных типов данных, с помощью необязательных параметров.

Входные данные

Структура данных в формате JSON для переменной param:
{
   "ProjectID": (int),
   "ShowProject": (int),
   "ShowGroups": (int),
   "ShowPhrases": (int),
   "ShowLastCheck": (int),
   "ShowPreviousCheck": (int),
   "DateCheck": (date)
}

Описание параметров:
ПараметрОписаниеОбязательный
ProjectID Идентификатор проекта. Да
ShowProject Получить общую статистику и параметры проекта:
• 1 – да (по умолчанию);
• 0 – нет.
Нет
ShowGroups Получить общую статистику и параметры всех групп проекта:
• 1 – да (по умолчанию);
• 0 – нет.
Нет
ShowPhrases Получить статистику запросов и параметры всех фраз проекта:
• 1 – да (по умолчанию);
• 0 – нет.
Нет
ShowLastCheck Получить данные актуальной проверки:
• 1 – да (по умолчанию);
• 0 – нет.
Нет
ShowPreviousCheck Получить данные предыдущей проверки:
• 1 – да (по умолчанию);
• 0 – нет.
Нет
DateCheck Получить данные по указанной дате, формат: "DD.MM.YYYY". Даты, по которым осуществлялась проверка проекта, можно получить при помощи GetDateChecks.
Если по указанной дате проверка не проводилась, то будут предоставлены данные ближайшей проверки до этой даты.
Если необходимо получить данные актуальной проверки, то этот параметр должен отсутствовать в запросе.
Нет

Пример структуры переменной param для PHP:
array(
   "ProjectID" => 539,
   "ShowProject" => 1,
   "ShowGroups" => 1,
   "ShowPhrases" => 1,
   "ShowLastCheck" => 1,
   "ShowPreviousCheck" => 1,
   "DateCheck" => "27.06.2014"
)

Результирующие данные

При успешном выполнении, метод возвращает объект в формате JSON. Структура результирующих данных:
{
   "data": {   /* ProjectData */
      "ProjectID": (int),
      "Name": (string),
      "DirectoryID": (int),
      "SortNumber": (int),
      "DateCreate": (date),
      "DateLastCheck": (date),
      "FrequencyMode": (int),
      "FrequencyDays": (string),
      "FrequencyHour": (int),
      "PhrasesAll": (int),
      "RequestsAll": (int),
      "RequestsUp": (int),
      "RequestsDown": (int),
      "RequestsVisibile": (int),
      "RequestsTop3": (int),
      "RequestsTop10": (int),
      "CheckNow": (int),
      "CheckTimer": (time),
      "Groups": [
         {   /* GroupsData */
            "GroupID": (int),
            "Name": (string),
            "SortNumber": (int),
            "DateCreate": (date),
            "Domains": [
               (string)
               ...
            ],
            "Searchers": [
               (string)
               ...
            ],
            "Statistics": (string)
            "PhrasesAll": (int),
            "RequestsAll": (int),
            "RequestsVisibile": (int),
            "Phrases":   [
               {   /* PhrasesData */
                  "PhraseID": (int),
                  "Name": (string),
                  "SortNumber": (int),
                  "DateCreate": (date),
                  "Wordstat": (int),
                  "PositionsLast": {
                     "BySearchers": [
                        (int)
                        ...
                     ]
                  },
                  "PositionsPrev": {
                     "BySearchers": [
                        (int)
                        ...
                     ]
                  }
               }
               ...
            ]
         }
         ...
      ]
   },
   "error": 0
}

Описание параметров:
ПараметрОписание
  Объект ProjectData
ProjectID Идентификатор проекта.
Name Название проекта.
DirectoryID Идентификатор раздела к которому прикреплен данный проект.
SortNumber Порядковый номер в списке проектов аккаунта.
DateCreate Дата создания проекта, DD.MM.YYYY.
DateLastCheck Дата актуальной проверки, DD.MM.YYYY.
• 00.00.0000 - проверка проекта не проводилась.
FrequencyMode Режим проверки:
• 1 - каждый день;
• 2 - один или несколько раз в неделю;
• 0 - только по требованию.
FrequencyDays Дни недели запуска проекта при FrequencyMode = 2.
• 1- понедельник;
• 2 - вторник;
  ...
• 7 - воскресенье.
Данный параметр передается как строка и может содержать несколько цифр, каждая цифра обозначает соответствующий день недели.
FrequencyHour Часы запуска проекта при FrequencyMode = 1 или 2. Значение указывается в 24-часовом формате.
PhrasesAll Всего фраз в проекте.
RequestsAll Всего запросов в проекте. Данная величина равна количеству юнитов, необходимых для запуска проверки проекта.
RequestsUp Количество запросов с улучшением позиций.
RequestsDown Количество запросов с ухудшением позиций.
RequestsVisibile Количество запросов в области видимости, т.е. по которым искомый сайт был найден.
RequestsTop3 Количество запросов попавших в ТОП-3.
RequestsTop10 Количество запросов попавших в ТОП-10.
CheckNow Проверяется ли проект в данный момент:
• 1 - да;
• 0 - нет.
CheckTimer Время завершения проверки при CheckNow = 1, HH:MM.
Groups Массив объектов GroupsData, содержащий параметры групп и фраз.
  Объект GroupsData
GroupID Идентификатор группы.
Name Название группы.
SortNumber Порядковый номер группы в проекте.
DateCreate Дата создания группы, DD.MM.YYYY.
Domains Массив проверяемых доменных имен.
Searchers Массив поисковых систем, по которым проводится проверка.
Statistics Собираемая статистика запросов.
• Y - Wordstat
PhrasesAll Всего фраз в группе.
RequestsAll Всего запросов в группе.
RequestsVisibile Количество запросов в группе, по которым искомый сайт был найден.
Phrases Массив объектов PhrasesData, содержащий параметры фраз.
  Объект PhrasesData
PhraseID Идентификатор фразы.
Name Текст фразы.
SortNumber Порядковый номер фразы в группе.
DateCreate Дата создания фразы, DD.MM.YYYY.
Wordstat Статистика запросов Wordstat.
• -1 - данные отсутствуют.
PositionsLast Объект содержащий массив с данными актуальной проверки.
PositionsPrev Объект содержащий массив с данными предыдущей проверки.
BySearchers Массив результатов проверок по фразе. Данные выстроены в соответствии с заданной последовательностью поисковых систем в параметре Searchers.
• 0 - сайт не найден;
• -1 - данные отсутствуют.
 
» Задайте свой вопрос:
Ваше имя:     E-Mail:  
Отправить вопрос
Наверх   
Наверх