Parametri

I parametri della richiesta limitano i dati restituiti da un endpoint. Tutti i valori dei parametri della richiesta devono essere codificati in URL.

I seguenti parametri si aspettano valori in una sintassi speciale. Per l'elenco completo dei parametri obbligatori e facoltativi di ciascun endpoint, consulta il riferimento API.

seleziona

Esempio: field_a,field_b,field_c

Un elenco obbligatorio di nomi di campo separati da virgole. Specifica quali campi restituire dall'endpoint. Non tutti gli endpoint accettano questo parametro.

Consulta lo schema di risposta dell'endpoint nel riferimento API per l'elenco dei nomi di campo validi.

where

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

Un'espressione di filtro per restringere i risultati. La sintassi è descritta in dettaglio in Sintassi dei filtri. Non tutti gli endpoint accettano questo parametro.

Consulta la descrizione dei parametri dell'endpoint nel riferimento API per l'elenco dei nomi di campo validi che possono essere usati nell'espressione di filtro. Questo potrebbe differire dall'elenco dei nomi di campo del parametro select.

order_by

Esempio: field_a:desc,field_b:asc

Ordina i risultati in base al campo/ai campi specificato/i e alla direzione (desc o asc). Non tutti gli endpoint accettano questo parametro.

Consulta lo schema di risposta dell'endpoint nel riferimento API per l'elenco dei nomi di campo validi. È lo stesso elenco di nomi di campo del parametro select.