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

GetProjectStatistic
Получение общей статистики проекта.

На основе информации, которую можно получить с помощью данного метода, строится график общей статистики на странице проекта в пользовательском интерфейсе.

Внимание!
Данные общей статистики хранятся на сервере 3 месяца. Если для работы клиентского приложения необходимо использование данных за более длительный период, следует организовать сохранение данных на стороне клиента.

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

Структура данных в формате JSON для переменной param:

{
   "ProjectID": (int),
   "DateBegin": (date),
   "DateEnd": (date)
}

Описание параметров:

Параметр	Описание	Обязательный
ProjectID	Идентификатор проекта.	Да
DateBegin	Получить данные за период начиная с указанной даты, формат: "DD.MM.YYYY".	Нет
DateEnd	Получить данные за период завершая указанной датой, формат: "DD.MM.YYYY".	Нет

Примечания:
• если период не указан, предоставляются данные за 31 день до момента запроса;
• даты, по которым осуществлялась проверка проекта, можно получить при помощи GetDateChecks.

Пример структуры переменной param для PHP:

array(
   "ProjectID" => 539,
   "DateBegin" => "01.10.2014",
   "DateEnd" => "26.11.2014"
)

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

При успешном выполнении, метод возвращает объект в формате JSON. Структура результирующих данных:

{
   "data": {   /* ProjectData */
      "ProjectID": (int),
      "DateBegin": (date),
      "DateEnd": (date),
      "Statistic": [
         {   /* StatisticData */
            "DateCheck": (date),
            "AllSearchers": {   /* AllSearchersData */
               "Visibility": (float),
               "Top3": (float),
               "Top10": (float),
               "Top30": (float)
            },
            "Searchers": [
               {   /* SearchersData */
                  "Searcher": (string),
                  "Visibility": (float),
                  "Top3": (float),
                  "Top10": (float),
                  "Top30": (float),
               }
               ...
            ]
         }
         ...
      ]
   },
   "error": 0
}

Описание параметров:

Параметр	Описание
	Объект ProjectData
ProjectID	Идентификатор проекта.
DateBegin	Дата начала периода отображения статистики, формат: "DD.MM.YYYY".
DateEnd	Дата завершения периода отображения статистики, формат: "DD.MM.YYYY".
Statistic	Массив объектов StatisticData, содержащий данные статистики отдельно за каждый день, в который осуществлялась проверка.
	Объект StatisticData
DateCheck	Дата проверки, формат: "DD.MM.YYYY".
AllSearchers	Объект AllSearchersData, содержащий средние данные по всем проверяемым поисковым системам.
Searchers	Массив объектов SearchersData, содержащий данные отдельно по каждой поисковой системе.
	Объект AllSearchersData
Visibility	Процент видимости сайта по проверяемым фразам, в среднем по всем поисковым системам.
Top3	Процент фраз, где сайт найден на 1-3 позициях, в среднем по всем поисковым системам.
Top10	Процент фраз, где сайт найден на 1-10 позициях, в среднем по всем поисковым системам.
Top30	Процент фраз, где сайт найден на 1-30 позициях, в среднем по всем поисковым системам.
	Объект SearchersData
Searcher	Поисковая система с регионом, для которой приведены данные статистики, например: "Yandex.ru - Москва".
Visibility	Процент видимости сайта по проверяемым фразам.
Top3	Процент фраз, где сайт найден на 1-3 позициях.
Top10	Процент фраз, где сайт найден на 1-10 позициях.
Top30	Процент фраз, где сайт найден на 1-30 позициях.