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

Огляд конкурентів

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

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

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

timeoutinteger

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

limitinteger

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

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

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

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

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

country: Країна, у якій відстежується певне ключове слово. Дволітерний код країни (ISO 3166-1 alpha-2).
тип: string
enum: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "OTHER" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"

is_main_position: Виключає позиції з блоку «Огляди від ШІ», «Sitelinks», «Top stories», «Image packs», «Videos», «Discussions and forums» і пости в X (Twitter).
тип: boolean

is_main_position_prev: Виключає позиції з блоку «Огляди від ШІ», «Sitelinks», «Top stories», «Image packs», «Videos», «Discussions and forums» і пости в X (Twitter) на дату порівняння.
тип: boolean

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

keyword_difficulty: Оцінка того, наскільки складно потрапити в топ-10 органічних результатів пошуку за ключовим словом за шкалою 0–100.
тип: integer nullable

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

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

language: Мова SERP, для якої відстежується певне ключове слово.
тип: string

location: Локація (країна, штат/область або місто), у якій відстежується певне ключове слово.
тип: string

serp_features: «Функції SERP», які з’являються в результатах пошуку за ключовим словом.
тип: array(string)
enum: "paid_top" "paid_bottom" "paid_right" "paid_sitelink" "organic" "sitelink" "snippet" "image" "article" "knowledge_card" "knowledge_panel" "local_pack" "local_teaser" "news" "question" "review" "shopping" "tweet" "spelling" "video" "discussion" "ai_overview" "ai_overview_sitelink" "organic_shopping" "image_th" "video_th" "ai_overview_found"

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

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

tags: Список тегів, призначених певному ключовому слову.
тип: array(string)

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

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

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

date_comparedstring

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

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

Дата, станом на яку потрібні метрики, у форматі 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

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

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

Відповіді

keywordsarray<object>
competitors_listarray<object>

Інформація про конкурентів для заданого ключового слова. Включено такі поля: url, url_prev, position, position_prev, best_position_kind, best_position_kind_prev, traffic, traffic_prev, value, value_prev. Поля, що закінчуються на prev, додаються лише у режимі порівняння.

countrystring

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

Allowed values:ADAEAFAGAIALAMAOAQARASATAUAWAXAZBABBBDBEBFBGBHBIBJBLBMBNBOBQBRBSBTBVBWBYBZCACCCDCFCGCHCICKCLCMCNCOCRCUCVCWCXCYCZDEDJDKDMDODZECEEEGEHERESETFIFJFKFMFOFRGAGBGDGEGFGGGHGIGLGMGNGPGQGRGSGTGUGWGYHKHMHNHRHTHUIDIEILIMINIOIQIRISITJEJMJOJPKEKGKHKIKMKNKPKRKWKYKZLALBLCLILKLRLSLTLULVLYMAMCMDMEMFMGMHMKMLMMMNMOMPMQMRMSMTMUMVMWMXMYMZNANCNENFNGNINLNONPNRNUNZOMOTHERPAPEPFPGPHPKPLPMPNPRPSPTPWPYQARERORSRURWSASBSCSDSESGSHSISJSKSLSMSNSOSRSSSTSVSXSYSZTCTDTFTGTHTJTKTLTMTNTOTRTTTVTWTZUAUGUMUSUYUZVAVCVEVGVIVNVUWFWSYEYTZAZMZW
keywordstring

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

keyword_difficultyinteger or null

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

keyword_has_databoolean

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

keyword_is_frozenboolean

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

languagestring

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

locationstring

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

serp_featuresarray<string>

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

Allowed values:paid_toppaid_bottompaid_rightpaid_sitelinkorganicsitelinksnippetimagearticleknowledge_cardknowledge_panellocal_packlocal_teasernewsquestionreviewshoppingtweetspellingvideodiscussionai_overviewai_overview_sitelinkorganic_shoppingimage_thvideo_thai_overview_found
serp_updatedstring or null

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

serp_updated_prevstring or null

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

tagsarray<string>

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

volumeinteger or null

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