Skip to Content

Baza słów kluczowych: histogramy zbioru (getStatistics)

POST/api/keywords_analysis/reports/keywords/getStatistics

Zwraca rozkłady (histogramy) dla całego zbioru fraz pasujących do zapytania — w trzech wymiarach: liczby wyszukiwań, trudności frazy i kosztu kliknięcia. Każdy wymiar to lista kubełków { start, end, value }, gdzie value to liczba fraz w kubełku. Służy do oceny, jak wygląda cały zbiór, przed pobraniem pojedynczych wierszy przez getKeywords.


Żądanie

POST /api/keywords_analysis/reports/keywords/getStatistics

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 }

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.

Pole end ostatniego kubełka to string "*", nie liczba — oznacza „bez górnej granicy”. Parser oczekujący liczby wywróci się na ostatnim elemencie każdego histogramu.

Wywołanie zużywa jednostkę dziennego limitu keywords_analysis_queries_per_day. Ta sama para parameters + match_mode policzona ponownie zużywa kolejną jednostkę.

match_mode jest wymagane i przyjmuje wyłącznie wide, medium albo narrow — inna wartość zwraca 418.

Odpowiedź

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

przykładowa-odpowiedź
{ "success": true, "data": { "searches": [ { "start": 0, "end": 0, "value": 90 }, { "start": 10, "end": 10, "value": 1120 }, { "start": 20, "end": 20, "value": 305 }, { "start": 3600, "end": "*", "value": 9 } ], "difficulty": [ { "start": 1, "end": 10, "value": 0 }, { "start": 11, "end": 20, "value": 0 } ], "cpc": [ { "start": 0, "end": 0.49, "value": 1376 }, { "start": 0.5, "end": 0.99, "value": 669 } ] } }

Struktura odpowiedzi

NameTypeDefault
successboolean
data{ searches: { start: number; end: number | "*"; value: number; }[]; difficulty: { start: number; end: number | "*"; value: number; }[]; cpc: { start: number; end: number | "*"; value: number; }[]; }

Trzy histogramy; każdy to lista kubełków.

Błędy

Błędy tego endpointu przychodzą we wspólnej kopercie ze statusem 418.

Powiązane akcje

Ostatnia aktualizacja: