Анализ сайта API 2.0

Обновленная версия API.

Данные, полученные через API анализа, можно использовать для создания новых сервисов, приложений и виджетов. API предоставляет данные более чем по 70 тестам, историю данных и возможность их обновления.

Стоимость получения данных из базы (данные могут быть не актуальными) — 1 лимит.

Стоимость обновления всех тестов и данных — 5 лимитов (актуально для тарифов с августа 2024 года).

Методы API – Swagger

Как использовать API?

ЧЧтобы получить данные по домену, сначала рекомендуется сделать запрос на статус — "Получение статуса базового анализа". Это позволит вам узнать актуальность данных по последнему обновлению отчета. Этот запрос не имеет лимитов.

Если данные свежие, то есть были обновлены в течение последних 30 дней, просто выполните запрос на "Получение базового анализа". Если данные устарели, вы можете сразу запросить их обновление. Учтите, что процесс обновления занимает от 1 до 5 минут, но в часы пик может занять больше времени.

Проверить, обновился ли отчет, можно также через запрос статуса. После обновления статуса и данных вы сможете получить полные данные анализа.

Как получить данные

Данные отдаются в формате 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-ключ):

Ваш ключ апи:
Проверяемый домен:
Получение базового анализа (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%
Отправить

Примеры и использование

Наше API чаще всего используются студиями для быстрого анализа, мониторинга и создания отчётов.

Как можно использовать:

  • White-label анализ сайта

    Полностью рабочий анализ сайта в вашем оформлении у вас на сайте.

  • Помощь для создания клиентского аудита сайта

    Вы получаете все данные по сайту клиента и пишите свои тексты на каждый тест. После, аудит передаётся клиенту.

  • Массовый мониторинг

    Через API вы получаете данные по списку ваших сайтов, смотрите историю и отслеживаете показания на своей стороне.

  • Другое

    Различные боты для мессенджеров, виджеты, создание отчётов и другое.

Пример скрипта, для вывода нескольких тестов из анализа.

Доступные тесты:

Test
ResultsDescription
adultContent
adultContentfalse | true
adultWordsnull | (found words)
Adult words on page
analysisBotDisallowed
isDisallowedbool
The website is closed for indexing (for PR-CY BOT)
avgVisitDuration
avgVisitDurationnumber
Traffic — Avg Visit Duration (sec)
bounceRate
bounceRatenumber
Traffic — Bounce Rate (%)
category
categoryTopNamestring
Category web-site
countryRank
countryCodeCode country
countryRanknumber
Rating of sites by traffic on country
facebookSocial
coverSourcestring (url)
groupNamestring
likesnumber
linkstring (url)
picturestring (url)
Facebook Social Page info
favicon
faviconSrcstring (url)
Favicon
globalRank
globalRanknumber
Rating of sites by traffic
googleIndex
googleIndexnumber
Google Index Page (site:)
googleTransparencyReport
googleTransparencyReportStatussuccess | fail
Google Safe Browsing
httpStatusCode
allStatusCodesarray redirects
finalStatusCodenumber (final code)
isCyclicRedirecttrue | false
Final Http Status Code
ip
ipstring
Domain IP
ipCountry
ipCountryCodestring (code)
IP Country
ipIsp
ipIspNameISP Name
ipOrganizationNameOrganization Name
ISP IP
loadTime
connectionTimeouttrue | false
loadTimenumber (sec)
percentnumber (Better than)
Load Time
mainPageDescription
descriptionstring
descriptionIsGoodtrue | false
descriptionLengthnumber
Website Meta Description
mainPageEncoding
encodingstring
Website Encoding
mainPageExternalLinks
externalCountnumber
externalIndexCountnumber
Website External Links (single main page)
mainPageHeaders
headersarray: [text, type: (h1-h5)]
headersAreGoodtrue | false
headersCountarray
Website Page Headers (single main page)
mainPageInternalLinks
internalCountnumber
internalIndexCountnumber
Website Page Internal Links (single main page)
mainPagePageSize
pageSizenumber
Website Page Size (KB)
mainPageSickness
sicknessnumber
Text sickness on main page
mainPageTechs
browserTechsarray
MainPage used Techs
mainPageTextLength
textLengthnumber
MainPage Text Length
mainPageTitle
titlestring
titleIsGoodtrue | false
titleLengthnumber
Main Page Meta Title
mainPageWordsCount
wordsCountnumber
Main Page Words Count
megaindexBacklinks
megaindexBacklinksarray
Backlinks (Megaindex)
megaindexDomainsCount
megaindexDomainsCountnumber
Backlinks Domains Count (Megaindex)
megaindexElinks
megaindexElinksnumber
Elinks (Megaindex)
megaindexElinksUniq
megaindexElinksUniqnumber
Elinks Uniq (Megaindex)
megaindexGoogle
megaindexGooglearray
Website keyword from Google (Megaindex)
megaindexHistoryGoogle
effVolumenumber
volumenumber
wordsnumber
words3number
words5number
words10number
words20number
words50number
Keywords History Google (Megaindex)
megaindexHistoryYandex
effVolumenumber
volumenumber
wordsnumber
words3number
words5number
words10number
words20number
words50number
Keywords History Yandex (Megaindex)
megaindexLinksCount
megaindexLinksCountnumber
Links Count (Megaindex)
megaindexOrganicLinks
megaindexOrgPercentnumber
megaindexSeoPercentnumber
megaindexSeoPercentDiffnumber
Organic Links (Megaindex)
megaindexRank
megaindexDomainRankLognumber
megaindexTrustRankLognumber
Rank (Megaindex)
megaindexYandex
megaindexYandexarray
Website keyword from yandex (Megaindex)
microdataOpenGraph
ogDescriptionstring
ogFoundtrue | false
ogImagestring
ogTitlestring
Microdata Open Graph
microdataSchemaOrg
microdataSchemaOrgExiststrue | false
Microdata Schema.Org
page404BackLink
backLinktrue | false
404 page backlink to homepage
page404StatusCode
statusCodenumber
404 page status code
pageSpeedAvoidPlugins
pageSpeedAvoidPluginstrue | false
Google page Speed Avoid Plugins
pageSpeedConfigureViewport
pageSpeedConfigureViewporttrue | false
Google page Speed Configure Viewport
pageSpeedDesktop
cumulativeLayoutShift{score: number, value: number}
largestContentfulPaint{score: number, value: number}
pageSpeed{score: number, value: number}
Google page Speed Desktop
pageSpeedEnableGzipCompression
pageSpeedEnableGzipCompressiontrue | false
Google page Speed Enable Gzip Compression
pageSpeedLeverageBrowserCaching
pageSpeedLeverageBrowserCaching{resourcesCount: number, items: Array}
Google page Speed Leverage Browser Caching
pageSpeedMinifyResources
pageSpeedMinifyResources{css: 'true | false', js: 'true | false'}
Google page Speed Minify Resources
pageSpeedMobile
cumulativeLayoutShift{score: number, value: number}
largestContentfulPaint{score: number, value: number}
pageSpeed{score: number, value: number}
Google page Speed Mobile
pageSpeedOptimizeImages
pageSpeedOptimizeImagestrue | false
Google pageSpeedOptimizeImages
pageSpeedSizeContentToViewport
pageSpeedSizeContentToViewporttrue | false
Google page Speed Size Content To Viewport
pageSpeedUnusedCssRules
pageSpeedUnusedCssRulestrue | false
Google page Speed Unused Css Rules
pageSpeedUseLegibleFontSizes
pageSpeedUseLegibleFontSizestrue | false
Google page speed use legible font sizes
pagesPerVisit
pagesPerVisitnumber
Pages Per Visit (Traffic)
prcyRank
prcyGradenumber
prcyRankLinksFactorstring
prcyRankTotalnumber
prcyRankTrafficFactorstring
prcyRankTrustFactorstring
PRCY Rank ("high", "medium", "low")
publicStatistics
publicStatisticsAlexaVisitsnumber
publicStatisticsAlexaVisitsMonthlynumber
publicStatisticsLiveInternetVisitsnumber
publicStatisticsLiveInternetVisitsMonthlynumber
publicStatisticsMetrikaVisitsnumber
publicStatisticsMetrikaVisitsMonthlynumber
publicStatisticsPageViewsDailynumber
publicStatisticsPageViewsMonthlynumber
publicStatisticsPageViewsWeeklynumber
publicStatisticsPrcyDatedate
publicStatisticsPrcyVisitsnumber
publicStatisticsPrcyVisitsMonthlynumber
publicStatisticsSourceLinkstring
publicStatisticsSourceTypestring
publicStatisticsVisitsDailynumber
publicStatisticsVisitsMonthlynumber
publicStatisticsVisitsWeeklynumber
Website traffic info
robotsTxt
robotsFileExiststrue | false
robotsFileHashstring
robotsFileMainPageDisallowedRobotsarray[]
Robots.txt
roskomnadzor
roskomnadzorDomainForbiddentrue | false
roskomnadzorIpForbiddentrue | false
Russian Federal Service for Supervision
sameCounters
sameCountersActualFoundnumber
sameCountersTotalFoundnumber
sameCountersWithDomains{}
Domain with same counters
sameIps
sameIpsTotalFoundnumber
sameIpsWithDomains{ip: {dateFound: {}, dateLost: {}, linkedDomains: Array}}
Domains with same IP
screenshotDesktop
srcstring
Screenshot Desktop
screenshotSmartphone
srcstring
Screenshot Smartphone
sitemap
sitemapUrlstring
Website
socialCounters
facebookLinkShareCountnumber
overallCountnumber
vkontakteShareCountnumber
All Social Share Counters
socialTraffic
socialTraffic[socials]array[ domain: string, percent: number]
Traffic Social
ssl
certValidTodate
sslAccesstrue | false
Website SSL
statisticsSystems
statisticsSystemsarray
Website Analytics Systems
totalBytes
itemsarray
itemsCountnumber
pageSizenumber
Google Speed Test Total Bytes Resources
trafficSources
trafficSourcesDirectnumber
trafficSourcesMailnumber
trafficSourcesReferralnumber
trafficSourcesSocialnumber
trafficSourcesOrganicSearchnumber
trafficSourcesPaidSearchnumber
trafficSourcesAdsnumber
Website
twitterSocial
followersnumber
followingnumber
linkstring
profileDescriptionstring
profileImageUrlstring
profileNamestring
tweetsnumber
Twitter account info
vkontakteSocial
groupCitystring
groupCounters[market_services: number, articles: number, narratives: number]
groupCountrystring
groupDescriptionstring
groupMembersCountnumber
groupNamestring
groupPhotostring
groupPhotoBigstring
groupPhotoMediumstring
groupStatusstring
groupTypestring
groupVerifiednumber
linkstring
VK.com info
whoisCreationDate
whoisCreationDatedate
Whois Creation Date
whoisExpirationDate
whoisExpirationDatedate
Whois Expiration Date
wwwRedirect
wwwRedirecttrue | false
Www Redirect to without www
yandexAchievements
yandexAchievementsOfficialtrue | false
yandexAchievementsMarketRatingnumber
yandexAchievementsHttpstrue | false
yandexAchievementsTurbotrue | false
Yandex Achievements
yandexAgs
yandexAgstrue | false
Website
yandexIndex
yandexIndexnumber
Yandex Index pages
yandexSafeBrowsing
yandexSafeBrowsingtrue | false
Yandex Safe Browsing
yandexSqi
yandexSqinumber
Yandex Sqi