Szczegóły frazy: liczba konkurentów (getCompetitorsNumber)
/api/keywords_analysis/reports/keyword_details/getCompetitorsNumberZwraca liczbę domen konkurujących o podaną frazę. Pojedyncza liczba — najtańszy sposób oceny, jak zatłoczona jest fraza, przed pobraniem pełnych raportów.
Raport odpytujesz wprost frazą i krajem — bez wcześniejszego tworzenia zadania w Analizie SERP. Jedno żądanie zastępuje ścieżkę „utwórz zadanie → sprawdź status → pobierz wynik” i nie zużywa limitu zadań.
Żądanie
GET /api/keywords_analysis/reports/keyword_details/getCompetitorsNumber
Nagłówki: Authorization: Bearer <token>.
Parametry przekazuje się w query stringu.
Żądanie
{
"keyword": "hamak",
"country_id": 1
}Parametry
| Name | Type | Default |
|---|---|---|
keyword | stringWymagane. Fraza kluczowa, dla której pobierany jest raport. Pusty string zwraca | |
country_id | numberWymagane. Identyfikator kraju; musi istnieć w słowniku krajów — nieznana wartość zwraca
| 1 |
page | numberWalidowane, ale bez efektu — ta akcja zwraca pojedynczy obiekt bez paginacji. | |
limit | numberWalidowane, ale bez efektu — brak paginacji w odpowiedzi. |
To metoda GET — parametry przekazuje się w query stringu. Wysłanie ich w treści żądania kończy się 418, bo endpoint czyta wyłącznie query.
Zarówno keyword, jak i country_id są wymagane. Nieznane country_id zwraca 418 z Unknown country_id, a wartość 200 jest mapowana na 1 — dla Polski trafisz więc do bazy 1.0, nie 2.0.
Odpowiedź
Przykład poniżej to rzeczywista odpowiedź produkcyjna dla frazy hamak (country_id: 1),
skrócona do jednego wiersza.
{
"success": true,
"data": {
"competitors_number": 6290
}
}Struktura odpowiedzi
Błędy
Błędy tego endpointu przychodzą we wspólnej kopercie ze statusem 418.
Powiązane akcje
Wszystkie poniższe raporty przyjmują tę samą parę keyword + country_id:
getStatistics— zbiorcze statystyki frazy.getQuestions— pytania o frazę.getKeywordsPropositions— propozycje fraz.getRelatedKeywords— frazy powiązane.getTopicLeaders— liderzy tematu.getGroups— grupy frazy.