Query parameters
This section explains:
- What query parameters are
- Where to find additional information about the API query language
What are query parameters?
You use query parameters to filter and paginate the results an API call returns. They are appended to the end of the request URL after a question mark.
For example:
| Example Query Parameter |
|---|
https://api.iot-x.com/alerts?name=example |
This is useful for retrieving basic information from an API, however, it does not provide you with the flexibility needed to make complex calls. If you are making a complex query, you may prefer to use the API query language.
API query language
The API query language extends the scope of query parameters and allows you to make complex requests.
Info
For further information about the API query language, including examples of how to structure queries using it, please refer to the Filtering topic.