Параметри

Параметри запиту обмежують дані, які повертає ендпойнт. Усі значення параметрів запиту мають бути URL-кодовані.

Наведені нижче параметри очікують значення у спеціальному синтаксисі. Щоб переглянути повний перелік обов’язкових і необов’язкових параметрів для кожного ендпойнта, перейдіть до довідника API.

вибрати

Приклад: field_a,field_b,field_c

Обов’язковий список назв полів, розділених комами. Визначає, які поля повертати з ендпойнта. Цей параметр підтримують не всі ендпойнти.

Зверніться до схеми відповіді ендпойнта в довіднику API, щоб отримати перелік коректних назв полів.

where

Приклад: {"and":[{"field":"field_a","is":["gt",90]},{"field":"field_b","is":["eq","SEO"]}]}

Вираз фільтрації для звуження результатів. Синтаксис детально описано в розділі Синтаксис фільтрів. Цей параметр підтримують не всі ендпойнти.

Див. опис параметра ендпойнта в довіднику API, щоб отримати перелік коректних назв полів, які можна використовувати у виразі фільтрації. Цей список може відрізнятися від списку назв полів у параметрі select.

order_by

Приклад: field_a:desc,field_b:asc

Сортує результати за вказаним(и) полем(ями) та напрямком (desc або asc). Цей параметр підтримують не всі ендпойнти.

Зверніться до схеми відповіді ендпойнта в довіднику API, щоб отримати перелік коректних назв полів. Це той самий список назв полів, що й у параметрі select.