Skip to Content
ModułyBaza słów kluczowychFrazy w grupie zbioru

Baza słów kluczowych: frazy w grupie (getGroupKeywords)

POST/api/keywords_analysis/reports/keywords/getGroupKeywords

Zwraca pojedyncze frazy wraz z metrykami dla zbioru zawężonego jak w getGroups. Kształt wiersza jest taki sam jak w getKeywords, a wyniki można sortować polem order.

Żądanie

POST /api/keywords_analysis/reports/keywords/getGroupKeywords

Nagłówki: Authorization: Bearer <token>, Content-Type: application/json. Parametry przekazuje się w treści żądania.

żądanie.jsonc
{
  "parameters": [
    {
      "data_fetch_mode": "keyword",
      "value": [
        "buty do biegania"
      ]
    }
  ],
  "match_mode": "wide",
  "country_id": 1,
  "limit": 3
}

Parametry

NameTypeDefault
parameters{ data_fetch_mode: string; value: string[]; }[]

Wymagane. Zapytanie do bazy: lista obiektów { data_fetch_mode, value }. Tryb keyword przyjmuje listę fraz w value.

match_mode"wide" | "medium" | "narrow"

Wymagane. Szerokość dopasowania frazy: wide | medium | narrow.

country_idnumber

Wymagane. Identyfikator kraju; nieznana wartość zwraca 418 z Unknown country_id.

filtering{ filters: { key: string; match?: "gt" | "gte" | "lt" | "lte" | "eq"; value: string | number | (string | number)[]; }[]; conjunction?: "and" | "or"; }[]

Filtry — tablica grup łączonych OR. Nieznany key zwraca 418 z invalid_filtering.

order{ prop: string; dir: "ASC" | "DESC"; }

Sortowanie wyników.

pagenumber

Numer strony wyników.

limitnumber

Liczba wierszy na stronę.

Metryki są zdublowane trzykrotnie: pola najwyższego poziomu, płaskie trend_1 … trend_12 oraz obiekt statistics. Wybierz jedno źródło.

Pole snippets powtarza wartości — dla frazy nike airmax API zwróciło image_thumbs, pla, top_bar trzy razy pod rząd. Odfiltruj duplikaty po swojej stronie.

Liczba wierszy podlega limitowi keywords_analysis_rows_per_report.

Odpowiedź

Przykład to rzeczywista odpowiedź produkcyjna, skrócona.

przykładowa-odpowiedź
{
  "success": true,
  "data": [
    {
      "added": "2021-10-19",
      "keyword": "nike airmax",
      "searches": 135000,
      "cpc": 0.67,
      "cpc_min": 0.23,
      "cpc_max": 1.1,
      "words_count": 2,
      "kid": "c9db40a54eacd9ab571c31b82d0b1ac5",
      "variations": [],
      "variations_number": 0,
      "snippets": [
        "image_thumbs",
        "pla",
        "top_bar",
        "image_thumbs",
        "pla",
        "top_bar",
        "image_thumbs",
        "pla",
        "top_bar"
      ],
      "trends": [
        90500,
        110000,
        201000,
        165000,
        135000,
        110000,
        110000,
        135000,
        135000,
        110000,
        90500,
        74000
      ]
    }
  ],
  "pagination": {
    "page_count": 2982,
    "current_page": 1,
    "has_next_page": true,
    "has_prev_page": false,
    "count": 8944,
    "limit": 3
  }
}

Struktura odpowiedzi

NameTypeDefault
successboolean
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; ... 4 more ...; statistics: Record<...>; }[]
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

Ostatnia aktualizacja:
Grupy zbioruPowiązane