Sekcje i URL-e: subdomeny (`getSubdomains`)

POST/api/visibility_analysis/reports/sections/getSubdomains

Zwraca widoczność domeny w rozbiciu na subdomeny. Każdy wiersz odpowiada jednej subdomenie (pole domain zawiera jej nazwę) i obok statystyk visibility, top3, top10 i top50 zawiera dodatkowo visibility_coverage — pokrycie widoczności całej domeny przez daną subdomenę. Użyj tej akcji, aby sprawdzić, jak widoczność rozkłada się między subdomeny serwisu.

Podgląd · 6 z 23 kolumn

Domena	Frazy	Udział wid. %	Widoczność	Widoczność poprz.	Widoczność Δ
zalando.pl	114 658	100	5 434 165,18	5 380 498,4	53 666,78

zalando.pl — domena nie ma innych subdomen, stąd jeden wiersz z pełnym pokryciem widoczności. Wszystkie pola wiersza (poza mapami historii statistics.*.history o kluczach-datach — są w JSON; w tej odpowiedzi mają wartość null).

Żądanie

POST /api/visibility_analysis/reports/sections/getSubdomains

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/sections/getSubdomains' \
  --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 `subdomain` — pojedyncza subdomena `catalog` — ścieżka/katalog `url` — dokładny URL Wartość `"domain"` nie istnieje — użyj `topLevelDomain`.
`country_id`	`number` Wymagane. Id kraju (bazy danych). Polska = `1`. Nieznana wartość zwraca `418` z komunikatem `Unknown country_id`.
`limit`	`number` Liczba wierszy na stronę.	`10`
`page`	`number` Numer strony.	`1`

Ten endpoint nie obsługuje parametrów order ani filtering. Jeśli je wyślesz, API zwróci 200, ale zostaną zignorowane — wyniki wracają w kolejności domyślnej. Zweryfikowane na prod — endpoint ich nie odczytuje. W przeciwieństwie do raportu positions, sekcje nie mają sortowania ani filtrowania po stronie API — jedyne parametry sterujące to limit i page.

Trzy parametry są wymagane (walidator SectionsValidator): domain, fetch_mode oraz country_id. Dozwolone wartości fetch_mode to topLevelDomain, subdomain, catalog i url — wartość "domain" nie istnieje. Nieznane country_id zwraca 418 z komunikatem "Unknown country_id".

Odpowiedź

W przypadku powodzenia otrzymujesz data (tablicę subdomen) oraz pagination. Dla zalando.pl API zwróciło jeden wiersz — domena nie ma innych subdomen, stąd visibility_percent i visibility_coverage wynoszą 100.

Skrócona

przykładowa-odpowiedź (skrócona)


{
  "success": true,
  "data": [
    { "domain": "zalando.pl", "keywords_count": 114658, "visibility_percent": 100, "statistics": { "visibility": { "current": 5434165.18 }, "visibility_coverage": { "current": 100 } /* … */ } }
  ],
  "pagination": { "page_count": 1, "current_page": 1, "has_next_page": false, "has_prev_page": false, "count": 1, "limit": 2 }
}

Struktura odpowiedzi

Name	Type	Default
`success`	`boolean` `true` przy powodzeniu; przy błędzie `false` i koperta z `error`
`data`	`SubdomainRow[]` Zwrócone wiersze z subdomenami
`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 również dla błędów walidacji — nie tylko przy ograniczeniu liczby żądań (rate limiting). Brak wymaganego pola zwraca invalid_data z mapą params, a nieznane country_id zwraca komunikat "Unknown country_id".

Powiązane akcje

getSections — widoczność zagregowana po sekcjach URL (katalogach) domeny
getSubdomains — widoczność per subdomena (ta strona)
getUrls — widoczność per pojedynczy adres URL

Sekcje i URL-e: subdomeny (getSubdomains)