get/projects_2/projects

Описание метода

Получает список проектов.

Параметры метода

Параметр Тип Описание По умолчанию
Обязательные
- -
Дополнительные
show_site_stat boolean Добавить в результат дополнительную информацию (кол‑во страниц в индексе, кол‑во ссылок, ИКС и т.д.) 0
show_searchers_and_regions boolean Добавить в результат список ПС и регионов, привязанных к проекту 0
include_positions_summary_params array

Добавить в результат сводку с указанными параметрами.

Возможные ключи массива см. в параметрах метода: get/positions_2/summary

Пример: ['show_dynamics' => 1, 'show_tops' => 1]

[]

Посмотреть в API Explorer

Пример с PHP SDK на GitHub

Как получить список проектов с их URL и названиями?
Укажите получаемое поле (field) url, name. Подобным образом можно получать и другую информацию о проектах: статус проекта, находится ли проект в Избранном и т.п.
{
	"limit": 10,
	"fields": [
		"url",
		"name"
	]
}
Как посмотреть процент выполнения проверки?
Укажите получаемое поле (field) positions_percent, а если нужно узнать процент выполнения проверки у конкретного проекта, то добавьте фильтр по id.
{
	"limit": 10,
	"fields": [
		"positions_percent"
	],
	"filters": [
		{
			"name": "id",
			"operator": "EQUALS",
			"values": [
				"5046129"
			]
		}
	]
}
Как узнать regions_indexes, которые нужны для получения истории позиций?
Индекс региона можно узнать с помощью дополнительного параметра (boolean) show_searchers_and_regions. Значение индекса будет в параметре index.
{
	"limit": 10,
	"show_searchers_and_regions": "1"
}
Как получить список всех регионов сервиса?
Получить все доступные регионы списком возможности нет, однако вы можете осуществить поиск по базе регионов с помощью get/system_2/common/regions. Подробнее о методе →
Например, с помощью запроса ниже мы узнаем region key для региона Филадельфия, который можно использовать для добавления региона в проект. Значения region key будет указано в параметре ID в ответе.
{
	"limit": 10,
	"searcher_key": "1",
	"search": "филад"
}

Как вывести данные из колонок, доступных в списке проектов (Видимость, количество запросов в ТОПе, ссылок и т.п.)?
Используйте массив (array) include_positions_summary_params, чтобы добавить в результат Сводку с указанными параметрами. Возможные ключи массива см. в параметрах метода: get/positions_2/summary
{
	"limit": 10,
	"include_positions_summary_params": [
		"show_visibility",
		"show_tops"
	]
}
Используйте дополнительный параметр (boolean) show_site_stat, чтобы добавить в результат больше информации о проекте (кол‑во страниц в индексе, кол‑во ссылок, ИКС и т.д.).
{
	"limit": 10,
	"show_site_stat": "1"
}
Как получить точные и усредненные значения из списка проектов, например, по распределению запросов по ТОПам?
Значения данных в Сводке (например, распределения по ТОПам, Видимости и пр.), получаемые с помощью метода get/projects_2/projects, являются средними по всем поисковым системам и регионам, добавленным в проект. Чтобы получить точные значения по каждой ПС, региону и типу выдачи отдельно, используйте метод get/positions_2/summary.