Kanibalizacja: sekcje (`getSections`)

POST/api/visibility_analysis/reports/cannibalization/getSections

Zwraca zbiorczy widok raportu kanibalizacji w podziale na sekcje URL: dla każdej sekcji serwisu (np. zalando.pl/obuwie-damskie/) podawana jest liczba skanibalizowanych fraz. Użyj tej akcji, aby szybko zlokalizować obszary serwisu najbardziej dotknięte kanibalizacją, a następnie przejść do szczegółów przez getKeywords.

Sekcja URL	Skanibalizowane frazy
zalando.pl/	733
zalando.pl/obuwie-damskie/	138

zalando.pl (limit: 2) — sekcje URL z liczbą skanibalizowanych fraz. Wszystkie adresowalne pola wiersza (keywords_sum zwracane jest jako string).

Żądanie

POST /api/visibility_analysis/reports/cannibalization/getSections

Nagłówki: Authorization: Bearer <token>, Content-Type: application/json.

Struktura żądania

Podstawowy

żądanie-podstawowe.jsonc


{
  "domain": "zalando.pl",
  "fetch_mode": "topLevelDomain",
  "country_id": 1
}

Rozszerzony

żądanie-rozszerzone.jsonc


{
  "domain": "zalando.pl",
  "fetch_mode": "topLevelDomain",
  "country_id": 1,
  "limit": 2,
  "page": 1
}

cURL


curl --location --request POST 'https://api.senuto.com/api/visibility_analysis/reports/cannibalization/getSections' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer $YOUR_TOKEN_HERE' \
  --data-raw '{
    "domain": "zalando.pl",
    "fetch_mode": "topLevelDomain",
    "country_id": 1,
    "limit": 2
  }'

Parametry

Name	Type	Default
`domain`	`string` Wymagane. Domena, subdomena, katalog lub URL do analizy — interpretowane zgodnie z `fetch_mode`.
`fetch_mode`	`"topLevelDomain" \| "subdomain" \| "catalog" \| "url"` Wymagane. Sposób interpretacji `domain`. `topLevelDomain` — cała domena (najczęstszy przypadek) `subdomain` — pojedyncza subdomena `catalog` — ścieżka/katalog `url` — dokładny URL
`country_id`	`number` Wymagane. Id kraju (bazy danych). Polska = `1`. Nieznana wartość → `418` z komunikatem `Unknown country_id`.
`limit`	`number` Liczba wierszy na stronę.	`10`
`page`	`number` Numer strony.	`1`
`days_compare_mode`	`"week_ago_monday" \| "last_monday" \| "yesterday"` Okres odniesienia do porównania (baza wykrywania zmian kanibalizacji). Walidowane — dozwolone: `week_ago_monday` (domyślny), `last_monday`, `yesterday`; inna wartość zwraca `418`.

W przeciwieństwie do cannibalization/getKeywords, ten endpoint nie obsługuje order ani filtering — kontroler ich nie odczytuje. Sterowanie wynikiem to limit/page oraz days_compare_mode.

Trzy parametry są wymagane: domain, fetch_mode oraz country_id. Nieznane country_id zwraca 418 z komunikatem Unknown country_id. Parametry page i limit są opcjonalne (domyślnie 1 / 10). Uwaga: pole keywords_sum w odpowiedzi jest łańcuchem znaków (np. "733"), nie liczbą — przed obliczeniami skonwertuj je na liczbę.

Odpowiedź

W przypadku powodzenia otrzymujesz data (tablicę sekcji URL z liczbą skanibalizowanych fraz) oraz pagination. Zwróć uwagę, że keywords_sum jest zwracane jako łańcuch znaków, a nie liczba.

Skrócona

przykładowa-odpowiedź (skrócona)


{
  "success": true,
  "data": [
    { "section": "zalando.pl/", "keywords_sum": "733" }
  ],
  "pagination": { "count": 646, "limit": 2 /* … */ }
}

Struktura odpowiedzi

Name	Type	Default
`success`	`boolean` `true` przy powodzeniu; przy błędzie `false` i koperta z `error`
`data`	`CannibalizationSectionRow[]` Zwrócone wiersze z sekcjami URL
`pagination`	`{ page_count: number; current_page: number; has_next_page: boolean; has_prev_page: boolean; count: number; limit: number; }` Metadane paginacji

Błędy

Name	Type	Default
`success`	`false`
`data`	`{ error: { type: string; message: string; params?: Record<string, Record<string, string>>; }; }`

418 zwracany jest także dla błędów walidacji. Nieznane country_id → komunikat Unknown country_id. Pominięcie któregokolwiek wymaganego pola (domain, fetch_mode, country_id) skutkuje błędem walidacji.

Powiązane akcje

getKeywords — frazy dotknięte kanibalizacją wraz ze statystykami
getSections — liczba skanibalizowanych fraz w podziale na sekcje URL (ta strona)

Kanibalizacja: sekcje (getSections)