Анализ сайта API
API Анализа — это интерфейс, который представляет из себя набор команд, выполняющих тесты из Анализа сайтов. Данные, полученные через API Анализа, можно использовать как конструктор, чтобы создавать новые сервисы, приложения и виджеты. В API вы получаете все данных о более 70 тестов, историю данный и возможность обновления данных.
Максимальное количество запросов к API – 200 в час. Запросы на получение статуса анализа не ограничены.
Как получить данные
Данные отдаются в формате JSON. Для получения данных необходимо сделать соответствующий запрос.
Получение базового анализа (GET-запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/base/%DOMAIN%?key=%KEY%
Получение статуса базового анализа (GET-запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/status/base/%DOMAIN%?key=%KEY%
Обновление базового анализа (POST запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/update/base/%DOMAIN%?key=%KEY%
Получение расширенного анализа (GET-запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/advanced/%DOMAIN%?key=%KEY%
Получение статуса расширенного анализа (GET-запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/status/advanced/%DOMAIN%?key=%KEY%
Обновление расширенного анализа (POST-запрос)
https://apis.pr-cy.ru/api/v1.1.0/analysis/update/advanced/%DOMAIN%?key=%KEY%
При необходимости можно ограничить список тестов только необходимыми, а также скрыть историю результатов. Для этого следует использовать параметры в GET-запросе: tests, excludeHistory.
https://apis.pr-cy.ru/api/v1.1.0/analysis/base/%DOMAIN%?key=%KEY%&excludeHistory=1&tests=%TESTS%
%KEY% — ваш ключ. Который можно получить в настройках.
%DOMAIN% — проверяемый домен.
%TESTS% — список тестов через запятую. Например: page404StatusCode,robotsTxt.
Playground (необходим API-ключ):
Примеры и использование
Наше API чаще всего используются студиями для быстрого анализа, мониторинга и создания отчётов.
Как можно использовать:
White-label анализ сайта
Полностью рабочий анализ сайта в вашем оформлении у вас на сайте.
Помощь для создания клиентского аудита сайта
Вы получаете все данные по сайту клиента и пишите свои тексты на каждый тест. После, аудит передаётся клиенту.
Массовый мониторинг
Через API вы получаете данные по списку ваших сайтов, смотрите историю и отслеживаете показания на своей стороне.
Другое
Различные боты для мессенджеров, виджеты, создание отчётов и другое.
Пример скрипта, для вывода нескольких тестов из анализа.
Доступные тесты:
| Test | Results | Description |
|---|---|---|
adultContent | adultContentfalse | trueadultWordsnull | (found words) | Adult words on page |
alexaRank | alexaCountryCodeCode countryalexaCountryRanknumberalexaGlobalRanknumber | Alexa Rank |
alexaRelatedSites | alexaRelatedSitesarrayalexaRelatedSites[]overlap: number, site: domain, rank: number | Alexa Related Sites |
alexaTrafficMap | alexaTrafficMaparrayalexaTrafficMap[]Country Code: number | Alexa Traffic Map (percent) |
analysisBotDisallowed | isDisallowedbool | The website is closed for indexing |
avgVisitDuration | avgVisitDurationnumber | Avg Visit Duration (sec) |
bounceRate | bounceRatenumber | Bounce Rate (%) |
category | categoryTopNamestring | Category web-site |
countryRank | countryCodeCode countrycountryRanknumber | Rating of sites by traffic on country |
domainAvailability | domainAvailabilityHostnamehostnamedomainAvailabilitySuffixesarray top-level domain | Domain search |