Spy[Words] API

Песочница

Песочница имитирует API SpyWords и предназначена для тестирования созданных приложений перед переводом в режим полноценной эксплуатации. При вызове методов из песочницы строки с вашего баланса не взимаются.

База данных песочницы полностью повторяет объем реальной БД API SpyWords, что позволяет протестировать приложения в режиме реальной нагрузки и большого объема получаемых данных.

В песочнице доступны все методы, но результирующие данные отличаются от реальных: текстовые данные после 7-го символа скрываются (например, «телевиз** ****** * *****», а числовые данные не отражают реальных показателей.

Адрес песочницы: https://api-sandbox.spywords.ru

Коды ошибок

Ниже приведены коды и описание возможных ошибок при получении ответа от сервера API

• ERROR 10 - ошибка авторизации, проверьте указанный токен
• ERROR 20 - недостаточно строк на балансе
• ERROR 30 - метод не поддерживается в вашем тарифе
• ERROR 40 - неправильно указан метод
• ERROR 50 - пропущен параметр
• ERROR 60 - неправильно указан параметр
• ERROR 70 - домен не содержится в базе данных или указан с ошибкой
• ERROR 80 - запрос не содержится в базе данных или указан с ошибкой
• ERROR 91 - домен №1 для сравнения не содержится в базе данных
• ERROR 92 - домен №2 для сравнения не содержится в базе данных
• ERROR 93 - домен №3 для сравнения не содержится в базе данных

Описание столбцов и сортировок

* Данные столбцы поддерживают возможность сортировки, для этого в запросе метода следует использовать параметр сортировки, например:
• asc=YandexCPC – сортировка стоимости клика в Яндекс по возрастанию
• desc=GoogleAdvTot – сортировка кол-ва рекламодателей в Google по убыванию
• asc=Pos – сортировка позиций в органическом поиске по возрастанию

Пример приложения на PHP

        	
<?
//адрес api
define("HTTP_API", "https://api.spywords.ru/?");

////////////////////////////////////////////////////////////////////////////////

$p="";

$p["method"] = "DomainOrganic";
$p["site"] = "bitrix24.ru";
$p["se"] = $_GET["se"] ? $_GET["se"] : "yandex";
if( $_GET["asc"] ) 		$p["asc"]  = $_GET["asc"]  ? $_GET["asc"]  : "";
elseif( $_GET["desc"] ) $p["desc"] = $_GET["desc"] ? $_GET["desc"] : "";
if( $_GET["limit"] ) $p["limit"] = $_GET["limit"];

//авторизация через login/token
$p["login"] = "test.api.spywords@spywords.ru";
$p["token"] = "6c812126714083d3f4e2b6d1656d3de5";

////////////////////////////////////////////////////////////////////////////////

//вызов API и разбор результатов

//echo "<br>Параметры:<br>";

echo "<div>";
foreach($p as $k=>$v){
	echo "<br>$k=<b ".($k=="method" ? "style=\"font-size:20px; color:blue\"":"").">$v</b>";
}
echo "</div><br>";

//echo "<br>Результат:<br>";

//вызов API
$fH = fopen($uri=HTTP_API.http_build_query($p), "rt");

//первая строка содержит ошибку | заголовки столбцов
$r = fgets($fH, 4096);

if( substr($r,0,5)=="ERROR"){
	//ошибка
	echo "<br><b style=\"color:red\">$r</b>";
}else{
	//заголовки столбцов
	$r = explode("\t", $r);
	echo "<div class=row>";
	foreach($r as $td){
		echo "<div class=th>$td</div>";
		//echo "$td ";
	}
	echo "</div>";
	//данные столбцов
	while(!feof($fH)) {
		$r = explode("\t", fgets($fH, 4096));

		echo "<div class=row>";
		foreach($r as $td){
			echo "<div class=td>$td</div>";
			//echo "$td ";
		}
		echo "</div>";
	}
}
                	       	

KeywordOverview

Метод предоставляет сводную информацию о ключевом слове в Яндекс и Google: количество рекламодателей, показы в месяц в формате точного соответствия и среднюю стоимость клика.

Пример запроса:

Обзор запроса «такси»

https://api.spywords.ru/?method=KeywordOverview&word=такси&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

KeywordAdv

Метод предоставляет информацию о рекламодателях по ключевому слову в Яндекс или Google: домен рекламодателя, текст объявления, url объявления, средняя позиция рекламодателя, общее кол-во запросов рекламодателя в контексте.

Пример запроса:

Рекламодатели по запросу «такси» в Яндекс.Директ

https://api.spywords.ru/?method=KeywordAdv&word=такси&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

KeywordOrganic

Метод предоставляет информацию о доменах в органическом поиске по ключевому слову в Яндекс или Google: позиция, индекс изменения позиции, домен рекламодателя, сниппет, url сниппета, общее кол-во запросов домена в поиске.

Пример запроса:

Домены в органической выдаче Яндекс по запросу «такси»

https://api.spywords.ru/?method=KeywordOrganic&word=такси&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainOverview

Метод предоставляет сводную информацию о домене в Яндекс и Google: кол-во запросов в контексте, средняя позиция объявлений, кол-во запросов в поиске, дневной бюджет на контекст, трафик в месяц из контекста, трафик в месяц из поиска.

Пример запроса:

Сводная информация по домену prostoy.ru

https://api.spywords.ru/?method=DomainOverview&site=prostoy.ru&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainOverviewHistory

Метод предоставляет динамику исторических показателей домена в Яндекс и Google: кол-во запросов в контексте, средняя позиция объявлений, кол-во запросов в поиске, дневной бюджет на контекст, трафик в месяц из контекста, трафик в месяц из поиска.

Пример запроса:

Динамика кол-ва запросов в контексте по домену sberbank.ru

https://api.spywords.ru/?method=DomainOverviewHistory&site=sberbank.ru&data=KeysAdTot&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainAdv

Метод предоставляет информацию о контекстных кампаниях рекламодателя в Яндекс или Google: ключевое слово, текст объявлений, позицию объявлений, url объявлений, кол-во показов данного ключевого слова, среднюю стоимость клика ключевого слова, кол-во конкурентов по данному ключевому слову.

Пример запроса:

Запросы и объявления рекламодателя amocrm.ru в Яндекс.Директ

https://api.spywords.ru/?method=DomainAdv&site=amocrm.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

UniqueAdv

Метод предоставляет информацию об уникальных объявлениях рекламодателя в Яндекс или Google: текст объявлений, url объявлений, кол-во запросов каждого объявления.

Пример запроса:

Рекламодатели по запросу «такси» в Яндекс.Директ

https://api.spywords.ru/?method=UniqueAdv&site=amocrm.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainOrganic

Метод предоставляет информацию о позициях домена в органическом поиске Яндекс или Google: ключевое слово, кол-во показов данного ключевого слова, позиция домена, индекс изменения позиции, сниппет, url сниппета.

Пример запроса:

Запросы и позиции домена bitrix24.ru в органическом поиске Яндекс

https://api.spywords.ru/?method=DomainOrganic&site=bitrix24.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainUrl

Метод предоставляет информацию о видимости страниц (УРЛов) домена в органическом поиске Яндекс или Google: адрес страницы, тайтл страницы, кол-во запросов, доля трафика, id страницы (используется для метода DomainUrlOgranic в параметре `&url=` для идентификации страницы)

Пример запроса:

Страницы домена bitrix24.ru в органическом поиске Яндекc

https://api.spywords.ru/?method=DomainUrl&site=bitrix24.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainUrlOrganic

Метод предоставляет информацию о запросах и позициях страницы (страниц) домена в органическом поиске Яндекс или Google: ключевое слово, кол-во показов данного ключевого слова, позици, индекс изменения позиции, сниппет, url сниппета.

Пример запроса:

Запросы и позиции страницы bitrix24.ru/features/crm.php домена bitrix24.ru в органическом поиске Яндекс

https://api.spywords.ru/?method=DomainUrlOrganic&site=bitrix24.ru&url=9071952fcfa3ad2360389e649891541c&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

CompareDomainTop10

Метод позволяет сравнить видимость домена в ТОП-10 органической выдачи Яндекс и Google. Доступны три сектора:

• - Уникальные запросы домена в ТОП-10 Яндекс
• - Уникальные запросы домена в ТОП-10 Google
• - Общие запросы домена в ТОП-10 Яндекс и Google

Пример запроса:

Домен bitrix24.ru – уникальные запросы в ТОП-10 Яндекс

https://api.spywords.ru/?method=CompareDomainTop10&site=bitrix24.ru§or=y&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainAdvCompetitors

Метод позволяет получить список конкурентов домена в контекстной рекламе Яндекс или Google, а также кол-во запросов, по которым исходный домен пересекается с конкурентами

Пример запроса:

Конкуренты домена bitrix24.ru в Яндекс.Директ

https://api.spywords.ru/?method=DomainAdvCompetitors&site=bitrix24.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

DomainOrganicCompetitors

Метод позволяет получить список конкурентов домена в органическом поиске Яндекс или Google, а также кол-во запросов, по которым исходный домен пересекается с конкурентами.

Пример запроса:

Конкуренты домена bitrix24.ru в органическом поиске Яндекс

https://api.spywords.ru/?method=DomainOrganicCompetitors&site=bitrix24.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

FightOverview

Метод позволяет сравнить сводную информацию 2-х или 3-х доменов в Яндекс или Google: кол-во запросов в контексте, среднюю позицию объявлений, кол-во запросов в поиске, дневной бюджет на контекст, трафик в месяц из контекста, трафик в месяц из поиска.

Пример запроса:

Сравнить сводные показатели доменов amocrm.ru, prostoy.ru, bitrix24.ru

https://api.spywords.ru/?method=FightOverview&site1=amocrm.ru&site2=prostoy.ru&site3=bitrix24.ru&se=yandex&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

FightAdv

Метод позволяет сравнить массивы используемых запросов в контекстной рекламе 2-х или 3-х доменов в Яндекс или Google.

Доступны 2 сектора данных: уникальные запросы для каждого из сравниваемых доменов, общие запросы сравниваемых доменов.

Пример запроса:

Сравнить домены amocrm.ru, prostoy.ru, bitrix24.ru в Яндекс.Директ и получить общие запросы

https://api.spywords.ru/?method=FightAdv&site1=amocrm.ru&site2=prostoy.ru&site3=bitrix24.ru&se=yandex§or=12&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

FightCompareAdv

Метод позволяет сравнить тексты и позиции объявлений 2-х или 3-х рекламодателей по пересекающимся запросам в контекстной рекламе Яндекс или Google.

Пример запроса:

Сравнить домены amocrm.ru, prostoy.ru, bitrix24.ru и получить сравнение объявлений amocrm.ru и prostoy.ru по пересекающимся запросам в Яндекс.Директ

https://api.spywords.ru/?method=FightCompareAdv&site1=amocrm.ru&site2=prostoy.ru&site3=bitrix24.ru&se=yandex§or=12&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

FightOrganic

Метод позволяет сравнить массивы запросов 2-х или 3-х доменов в органической выдаче Яндекс или Google.

Доступны 2 сектора данных: уникальные запросы для каждого из сравниваемых доменов, общие запросы сравниваемых доменов.

Пример запроса:

Сравнить домены amocrm.ru, prostoy.ru, bitrix24.ru в органическом поиске Яндекс и получить уникальные запросы amocrm.ru

https://api.spywords.ru/?method=FightOrganic&site1=amocrm.ru&site2=prostoy.ru&site3=bitrix24.ru&se=yandex§or=1&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

FightCompareOrganic

Метод позволяет сравнить позиции, индексы изменения позиций по общим запросам 2-х или 3-х доменов в органической выдаче Яндекс или Google.

Пример запроса:

Сравнить домены amocrm.ru, prostoy.ru, bitrix24.ru и получить сравнение позиций amocrm.ru и prostoy.ru по пересекающимся запросам в выдаче Яндекс

https://api.spywords.ru/?method=FightCompareOrganic&site1=amocrm.ru&site2=prostoy.ru&site3=bitrix24.ru&se=yandex§or=12&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

SmartKeywords

Метод позволяет получить для фразы / группы фраз (до 20 шт.) список дополнительных рекомендованных запросов и их параметры: кол-во показов, среднюю стоимость клика,
кол-во рекламодателей.

Пример запроса:

Умный подбор запросов для ключевого слова «такси»

https://api.spywords.ru/?method=SmartKeywords&word=такси&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

Balance

Метод позволяет узнать кол-во строк, доступных на балансе аккаунта.

Пример запроса:

https://api.spywords.ru/?method=Balance&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

History

Метод позволяет получить историю вызовов аккаунта за определенный промежуток времени: дата вызова, url, количество строк в результате.

Пример запроса:

https://api.spywords.ru/?method=History&date=2015-11-22+10%3A00%3A00&date2=2015-11-23+12%3A00%3A00&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса

LastUpdateDB

Метод позволяет узнать дату последнего обновления базы.

Пример запроса:

https://api.spywords.ru/?method=LastUpdateDB&login=test.api.spywords%40spywords.ru&token=6c812126714083d3f4e2b6d1656d3de5

Параметры запроса