Parametry

Parametry żądania ograniczają dane zwracane przez punkt końcowy. Wszystkie wartości parametrów żądania muszą być zakodowane w URL.

Poniższe parametry oczekują wartości w specjalnej składni. Pełną listę wymaganych i opcjonalnych parametrów dla każdego punktu końcowego znajdziesz w dokumentacji referencyjnej API.

wybierz

Przykład: field_a,field_b,field_c

Wymagana lista nazw pól rozdzielonych przecinkami. Określa, które pola mają zostać zwrócone przez punkt końcowy. Nie wszystkie punkty końcowe akceptują ten parametr.

Listę prawidłowych nazw pól znajdziesz w schemacie odpowiedzi punktu końcowego w dokumentacji referencyjnej API.

where

Przykład: {"and":[{"field":"field_a","is":["gt",90]},{"field":"field_b","is":["eq","SEO"]}]}

Wyrażenie filtra służące do zawężania wyników. Składnia jest szczegółowo opisana w Składnia filtrów. Nie wszystkie punkty końcowe akceptują ten parametr.

Listę prawidłowych nazw pól, których można użyć w wyrażeniu filtra, znajdziesz w opisie parametru punktu końcowego w dokumentacji referencyjnej API. Może się to różnić od listy nazw pól parametru select.

order_by

Przykład: field_a:desc,field_b:asc

Sortuje wyniki według wskazanego pola (wskazanych pól) i kierunku (desc lub asc). Nie wszystkie punkty końcowe akceptują ten parametr.

Listę prawidłowych nazw pól znajdziesz w schemacie odpowiedzi punktu końcowego w dokumentacji referencyjnej API. Jest taka sama jak lista nazw pól parametru select.