Baza słów kluczowych: grupy zbioru (getGroups)
/api/keywords_analysis/reports/keywords/getGroupsZwraca zbiór fraz pogrupowany tematycznie — każdy wiersz to grupa ze wspólnym fragmentem frazy, wraz z liczbą fraz i sumami oraz średnimi wyszukiwań i CPC. Pozwala zobaczyć strukturę dużego zbioru, zanim zejdziesz do pojedynczych fraz.
Żądanie
POST /api/keywords_analysis/reports/keywords/getGroups
Nagłówki: Authorization: Bearer <token>, Content-Type: application/json.
Parametry przekazuje się w treści żądania.
Żądanie
{
"parameters": [
{
"data_fetch_mode": "keyword",
"value": [
"buty do biegania"
]
}
],
"match_mode": "wide",
"country_id": 1,
"limit": 3
}Parametry
| Name | Type | Default |
|---|---|---|
parameters | { data_fetch_mode: string; value: string[]; }[]Wymagane. Zapytanie do bazy: lista obiektów | |
match_mode | "wide" | "medium" | "narrow"Wymagane. Szerokość dopasowania frazy: | |
country_id | numberWymagane. Identyfikator kraju; nieznana wartość zwraca | |
filtering | { filters: { key: string; match?: "gt" | "gte" | "lt" | "lte" | "eq"; value: string | number | (string | number)[]; }[]; conjunction?: "and" | "or"; }[]Filtry — tablica grup łączonych OR. Nieznany | |
page | numberNumer strony wyników. | |
limit | numberLiczba wierszy na stronę. |
Liczba pobieranych wierszy podlega limitowi keywords_analysis_rows_per_report — przy zbyt dużym limit albo wysokim page żądanie zwróci 418 z informacją o przekroczeniu limitu.
Paginacja jest rzeczywista: dla frazy buty do biegania w Polsce raport zwrócił count: 23239 grup. To inny endpoint niż keyword_details/getGroups, którego paginacja jest pozorna.
Odpowiedź
Przykład to rzeczywista odpowiedź produkcyjna, skrócona.
{
"success": true,
"data": [
{
"group": "do biegania",
"keywords_sum": 2902,
"searches_sum": 461430,
"searches_avg": 159,
"cpc_sum": 1536.35,
"cpc_avg": 0.53
},
{
"group": "buty do",
"keywords_sum": 2391,
"searches_sum": 413430,
"searches_avg": 172.91,
"cpc_sum": 1244.23,
"cpc_avg": 0.52
}
],
"pagination": {
"page_count": 7747,
"current_page": 1,
"has_next_page": true,
"has_prev_page": false,
"count": 23239,
"limit": 3
}
}Struktura odpowiedzi
| Name | Type | Default |
|---|---|---|
success | boolean | |
data | { group: string; keywords_sum: number; searches_sum: number; searches_avg: number; cpc_sum: number; cpc_avg: number; }[] | |
pagination | { page_count: number; current_page: number; has_next_page: boolean; has_prev_page: boolean; count: number; limit: number; } |
Błędy
Błędy tego endpointu przychodzą we wspólnej kopercie ze statusem 418.
Powiązane akcje
getKeywords— frazy ze zbioru.getGroupKeywords— frazy w obrębie grupy.keyword_details/getGroups— grupy dla jednej frazy.