Parameter

Anfrageparameter schränken die Daten ein, die ein Endpoint zurückgibt. Alle Werte von Anfrageparametern müssen URL-kodiert sein.

Die folgenden Parameter erwarten Werte in einer speziellen Syntax. Die vollständige Liste aller erforderlichen und optionalen Parameter für jeden Endpoint finden Sie in der API-Referenz.

auswählen

Beispiel: field_a,field_b,field_c

Eine obligatorische, kommagetrennte Liste von Feldnamen. Damit wird festgelegt, welche Felder der Endpoint zurückgibt. Nicht alle Endpoints unterstützen diesen Parameter.

Eine Liste gültiger Feldnamen finden Sie im Response-Schema des Endpoints in der API-Referenz.

where

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

Ein Filterausdruck, um die Ergebnisse einzugrenzen. Die Syntax wird in Filtersyntax ausführlich beschrieben. Nicht alle Endpoints unterstützen diesen Parameter.

Eine Liste gültiger Feldnamen, die im Filterausdruck verwendet werden können, finden Sie in der Parameterbeschreibung des Endpoints in der API-Referenz. Dies kann von der Feldnamensliste des select-Parameters abweichen.

order_by

Beispiel: field_a:desc,field_b:asc

Sortiert die Ergebnisse nach den angegebenen Feldern und der Richtung (desc oder asc). Nicht alle Endpoints unterstützen diesen Parameter.

Eine Liste gültiger Feldnamen finden Sie im Response-Schema des Endpoints in der API-Referenz. Dies entspricht der Feldnamensliste des select-Parameters.