Docs
Пошук документації...⌘K

Огляд

API + MCP
GET/v3/rank-tracker/overview

Запити до цього ендпоїнта безкоштовні та не витрачають жодних одиниць API.

Параметри запиту

timeoutinteger

Тривалість таймауту в секундах, задана вручну.

limitinteger

Кількість результатів, які потрібно повернути.

За Замовчуванням:1000
order_bystring

Список стовпців, розділених комами, за якими слід упорядкувати результати, з необов'язковим напрямком. Див. схему відповіді для дійсних ідентифікаторів стовпців.

Example:field_a,field_b:asc,field_c:desc
wherestring

Вираз фільтра. Розпізнаються такі ідентифікатори колонок (вони відрізняються від ідентифікаторів, які розпізнає параметр select).

selectstringОбов’язково

Список стовпців для повернення, розділений комами. Див. схему відповіді (Schema) для коректних ідентифікаторів стовпців.

date_comparedstring (date)

Дата для порівняння метрик у форматі YYYY-MM-DD.

datestring (date)Обов’язково

Дата, за яку потрібно надати метрики, у форматі YYYY-MM-DD.

devicestringОбов’язково

Виберіть позиції для мобільних або десктопних пристроїв.

Дозволені значення:desktopmobile
project_idintegerОбов’язково

Унікальний ідентифікатор проєкту. Його можна знайти в URL вашого проєкту Rank Tracker в Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

volume_modestring

Режим обчислення обсягу пошуку: щомісячний або середній. Він впливає на обсяг, трафік і цінність трафіку.

Дозволені значення:monthlyaverage
За Замовчуванням:monthly
outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Відповіді

overviewsarray<object>
best_position_has_thumbnailboolean or null

Найвища позиція (або цільова URL-адреса, якщо задано) має мініатюру.

best_position_has_thumbnail_previousboolean or null

Найвища позиція (або цільова URL-адреса, якщо задано) має мініатюру на дату порівняння.

best_position_has_video_previewboolean or null

Найвища позиція (або цільова URL-адреса, якщо задано) має попередній перегляд відео.

best_position_has_video_preview_previousboolean or null

Найвища позиція (або цільова URL-адреса, якщо задано) має попередній перегляд відео на дату порівняння.

best_position_kindstring or null

Тип найвищої позиції (або цільової URL-адреси, якщо задано): органічна, платна або «Функції SERP».

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
best_position_kind_previousstring or null

Тип найвищої позиції (або цільових URL-адрес, якщо задано) на дату порівняння.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shopping
clicksinteger or null

Показник «Кліки» означає середню місячну кількість кліків за результатами пошуку, які люди здійснюють під час пошуку за цільовим ключовим словом. Деякі пошукові запити генерують кліки одразу за кількома результатами, тоді як інші можуть не призвести до жодного кліку.

clicks_per_searchnumber (float) or null

Кількість кліків на пошук – це співвідношення кліків до частоти пошуку за ключовими словами. Показує, скільки в середньому різних результатів пошуку отримують кліки, коли люди здійснюють пошук за цільовим ключовим словом у певній країні.

cost_per_clickinteger or null

Ціна за клік показує середню ціну, яку рекламодавці платять за кожен клік по рекламі в платних результатах пошуку за ключовим словом.

countrystring

Країна, у якій відстежується задане ключове слово. Дволітерний код країни (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
country_prevstring

Країна, у якій відстежувалося задане ключове слово на дату порівняння. Дволітерний код країни (ISO 3166-1 alpha-2).

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
created_atstring (date-time)

Дата додавання ключового слова до проєкту.

is_brandedboolean

Намір користувача: брендовий. Користувач шукає конкретний бренд або назву компанії.

is_commercialboolean

Намір користувача: комерційний. Користувач порівнює товари чи послуги перед прийняттям рішення про покупку.

is_informationalboolean

Намір користувача: інформаційний. Користувач шукає інформацію або відповідь на конкретне запитання.

is_localboolean

Намір користувача: локальний. Користувач шукає інформацію, пов'язану з конкретною місцевістю або послугами поблизу.

is_navigationalboolean

Намір користувача: навігаційний. Користувач шукає конкретний вебсайт або сторінку.

is_transactionalboolean

Намір користувача: транзакційний. Користувач готовий виконати дію, зазвичай покупку.

keywordstring

Ключове слово, за яким ранжується ваш цільовий ресурс.

keyword_difficultyinteger or null

Оцінка складності потрапляння в топ-10 органічної видачі за ключовим словом за 100-бальною шкалою.

keyword_has_databoolean

Поверне false, якщо ключове слово все ще обробляється і SERP ще не було отримано.

keyword_is_frozenboolean

Показує, чи перевищило ключове слово ліміт відстежуваних ключових слів у вашому тарифному плані. Такі ключові слова «заморожені», тобто їхні позиції не оновлюються.

keyword_prevstring

Ключове слово, за яким ранжується ваш цільовий ресурс, на дату порівняння.

languagestring

Мова SERP, за якою відстежується задане ключове слово.

language_prevstring

Мова SERP на дату порівняння.

locationstring

Місце розташування (країна, штат/провінція або місто), де відстежується дане ключове слово.

location_prevstring

Місце розташування (країна, штат/провінція або місто), де відстежувалося дане ключове слово на дату порівняння.

parent_topicstring or null

Основна тема визначає, чи можете ви ранжуватися за цільовим ключовим словом, одночасно орієнтуючись на більш загальну тему на вашій сторінці. Щоб визначити основну тему, ми беремо сторінку №1 у рейтингу за вашим ключовим словом і знаходимо ключове слово, що відповідає за найбільший трафік на цій сторінці.

positioninteger or null

Найвища позиція (або цільових URL-адрес, якщо задано) в органічному пошуку.

position_diffinteger or null

Зміна найвищої позиції (або цільових URL-адрес, якщо задано) між вибраними датами.

position_previnteger or null

Найвища позиція (або цільових URL-адрес, якщо задано) на дату порівняння.

search_type_imagenumber (float) or null

Тип пошуку «Зображення» показує відсоток пошукових запитів за ключовими словами для зображень, що підкреслює інтерес до візуального контенту.

search_type_newsnumber (float) or null

Тип пошуку «Новини» показує відсоток пошукових запитів за ключовим словом для статей новин.

search_type_videonumber (float) or null

Тип пошуку ‭«Відео» показує відсоток пошукових запитів за ключовим словом для відео, що демонструє інтерес до відеоконтенту.

search_type_webnumber (float) or null

Тип пошуку Web показує відсоток пошукових запитів за ключовим словом, виконаних щодо загального вебконтенту, що вказує на інтерес до широкого спектра інформації.

serp_featuresarray<string>

Функції SERP, що з'являються в результатах пошуку за ключовим словом.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_features_prevarray<string>

Функції SERP, що з'являються в результатах пошуку за ключовим словом станом на дату порівняння.

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_updatedstring (date-time) or null

Дата, коли ми востаннє перевіряли результати з пошукової системи за ключовим словом.

serp_updated_prevstring (date-time) or null

Дата, коли ми перевірили результати пошукової системи станом на дату порівняння.

tagsarray<string>

Список тегів, призначених для вказаного ключового слова.

tags_prevarray<string>

Список тегів, призначених певному ключовому слову на дату порівняння.

target_positions_countinteger

Кількість цільових URL-адрес, що ранжуються за ключовим словом.

trafficinteger or null

Оцінка кількості щомісячних візитів, які сторінка отримує з органічного пошуку за останній місяць або за останні відомі 12 місяців даних — залежно від параметра "volume_mode".

traffic_diffinteger or null

Зміна в трафіку між вашими вибраними датами.

traffic_previnteger or null

Оцінка кількості щомісячних візитів, які сторінка отримує з органічного пошуку за останній місяць або за останні відомі 12 місяців даних — залежно від параметра "volume_mode".

urlstring (url) or null

URL, що займає найвищу позицію (або цільовий URL, якщо задано) в органічному пошуку.

url_prevstring (url) or null

URL, що займає найвищу позицію (або цільовий URL, якщо задано) на дату порівняння.

volumeinteger or null

Оцінка середньої щомісячної кількості пошукових запитів за ключовим словом за останній місяць або за останні відомі 12 місяців даних — залежно від параметра "volume_mode".

volume_desktop_pctnumber (float) or null

Відсоток загального обсягу пошуку, що припадає на десктопні пристрої.

volume_mobile_pctnumber (float) or null

Відсоток загального обсягу пошуку, що припадає на мобільні пристрої.