`Filter`

POST/api/visibility_analysis/reports/positions/getData

Wiele endpointów raportowych przyjmuje opcjonalny parametr filtering, który zawęża zwracane wiersze. To ten sam mechanizm, co pole Filtry nad tabelami w aplikacji Senuto.

Dostępne klucze filtrów różnią się per endpoint. Pełną listę znajdziesz na stronie danego endpointu, np. Pozycje → Filtrowanie.

Struktura

filtering to tablica grup. Każda grupa ma klucz filters — listę warunków. Warunki w obrębie jednej grupy łączone są operatorem AND.

filtering.jsonc


"filtering": [
  {
    "filters": [
      // filtr wartości (liczbowy / logiczny): { key, match, value }
      { "key": "statistics.position.current", "match": "lte", "value": 10 },
      // filtr tekstowy (frazy/URL): { key, items: [{ value, match }] }
      { "key": "keywords", "items": [{ "value": "buty", "match": "contain" }] }
    ]
  }
]

Aplikacja dodatkowo dołącza do każdego filtra pola type (np. "string") oraz filterSourceType (np. "customFilter"). Są one opcjonalne — API działa również bez nich.

Typy filtrów

Filtr wartości — `FilterNumeric`

Dla pól liczbowych i logicznych. Kształt: { key, match, value }.

`match`	Znaczenie
`eq`	równe
`gt`	większe niż
`gte`	większe lub równe
`lt`	mniejsze niż
`lte`	mniejsze lub równe

Filtr tekstowy — `FilterKeyword`

Dla fraz i pól tekstowych. Kształt: { key, items: [{ value, match }] } (wiele items rozszerza dopasowanie).

`match`	Znaczenie
`contain`	zawiera frazę
`containsWord`	zawiera słowo
`startsWith`	zaczyna się od
`endsWith`	kończy się na
`notContain`	nie zawiera

Filtr przynależności — `FilterInclusion`

Dla pól typu lista/zbiór (np. typy snippetów, intencje) — sprawdza przynależność wartości do dozwolonego zbioru.

Piaskownica

Przetestuj filtrowanie na realnym endpointcie pozycji (wklej swój token w pasku API token):

Jak filtry zawężają wynik — positions/getData dla zalando.pl filtr statistics.position.current ≤ 3 zawęża count z 291 121 do 46 546; filtr keywords contain "buty" → 20 333; oba w jednej grupie (AND) → 7 952.

Gdzie działa

Filtrowanie wspierają m.in.:

Analiza widoczności — Pozycje (pełny zestaw kluczy),
Analiza widoczności — Historia fraz (te same klucze),
Monitoring — Pozycje (getData) (filtr keywords).

Zestaw dostępnych kluczy jest specyficzny dla endpointu — sprawdzaj sekcję Filtrowanie na jego stronie.

Filter