Szczegóły frazy: propozycje fraz (getKeywordsPropositions)
/api/keywords_analysis/reports/keyword_details/getKeywordsPropositionsZwraca propozycje fraz pokrewnych do podanej — rozszerzenia i warianty do rozważenia przy budowie listy słów kluczowych. Kształt wiersza jest identyczny jak w pytaniach.
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ń.
Dla frazy hamak w Polsce raport zwrócił 5848 wierszy.
Żądanie
POST /api/keywords_analysis/reports/keyword_details/getKeywordsPropositions
Nagłówki: Authorization: Bearer <token>, Content-Type: application/json.
Parametry przekazuje się w treści żądania.
Żądanie
{
"keyword": "hamak",
"country_id": 1,
"limit": 10
}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 |
filtering | { filters: { key: string; match?: "gt" | "gte" | "lt" | "lte" | "eq"; value: string | number | (string | number)[]; }[]; conjunction?: "and" | "or"; }[]Filtry raportu — tablica grup łączonych operatorem OR. Działa na tej akcji.
Nieznany | |
page | numberNumer strony wyników. | |
limit | numberLiczba wierszy na stronę. |
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.
Metryki są zdublowane w trzech miejscach: pola najwyższego poziomu (searches, cpc, trends), płaskie trend_1 … trend_12 oraz obiekt statistics. Do integracji wybierz jedno źródło — statistics różni się tylko tym, że jego lista cech SERP jest bez duplikatów.
Odpowiedź
Przykład poniżej to rzeczywista odpowiedź produkcyjna dla frazy hamak (country_id: 1),
skrócona do jednego wiersza.
{
"success": true,
"data": [
{
"searches": 74000,
"cpc": 0.79,
"cpc_min": 0.28,
"cpc_max": 1.31,
"words_count": 2,
"trend_1": 135000,
"trend_2": 90500,
"trend_3": 60500,
"trend_4": 22200,
"trend_5": 12100,
"trend_6": 9900,
"trend_7": 8100,
"trend_8": 12100,
"trend_9": 27100,
"trend_10": 110000,
"trend_11": 135000,
"trend_12": 201000,
"added": "2021-06-22",
"keyword": "huśtawka ogrodowa",
"kid": "9c40f1c0405fe5ea7f00bdf8ec639a2f",
"variations": [
"hustawka ogrodowa",
"ogrodowa huśtawka"
],
"variations_number": 2,
"snippets": [
"adwords",
"image_thumbs",
"map",
"pla",
"top_bar",
"yellow_pages"
],
"trends": [
135000,
90500,
60500,
22200,
12100,
9900,
8100,
12100,
27100,
110000,
135000,
201000
],
"statistics": {
"snippets": {
"current": [
"adwords",
"image_thumbs",
"map",
"pla",
"top_bar",
"yellow_pages"
]
},
"searches": {
"current": 74000
},
"cpc": {
"current": 0.79
},
"cpc_min": {
"current": 0.28
},
"cpc_max": {
"current": 1.31
},
"trends": {
"history": [
135000,
90500,
60500,
22200,
12100,
9900,
8100,
12100,
27100,
110000,
135000,
201000
]
}
}
}
],
"pagination": {
"page_count": 2924,
"current_page": 1,
"has_next_page": true,
"has_prev_page": false,
"count": 5848,
"limit": 2
}
}Struktura odpowiedzi
| Name | Type | Default |
|---|---|---|
success | boolean | |
data | { keyword: string; added: string; searches: number; cpc: number; cpc_min: number | null; cpc_max: number | null; words_count: number; kid: string; variations: string[]; variations_number: number; ... 14 more ...; statistics: { ...; }; }[] | |
pagination | { page_count: number; current_page: number; has_next_page: boolean; has_prev_page: boolean; count: number; limit: number; }Paginacja liczona z całego zbioru — |
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ę.getRelatedKeywords— frazy powiązane.getTopicLeaders— liderzy tematu.getGroups— grupy frazy.getCompetitorsNumber— liczba konkurentów.