Arable Developer

# Column Filtering

If you are looking to reduce the amount of data you are querying, you can use one of these methods to filter which columns are returned:

# X-Fields

If you are interested in only retrieving specific parts of an object instead of the full object, you can use the X-Fields header to do just that.

Note: to request specific columns of data for the /data endpoint, we recommend using the faster select query paramater instead of the X-Fields header.

The X-Fields header is a comma-separated list of the object fields you want returned by the endpoint, surrounded by brackets.

# Usage

Fetch the e-mail and first_name of a user:

  -H 'Authorization: Apikey <apikey>' \
  -H 'X-Fields: {email,first_name}'

You can use nested brackets to filter nested objects or to filter a list of objects:

  -H 'Authorization: Apikey <apikey>' \
  -H 'X-Fields: {email,first_name,orgs{tenant}}'

Use * to request all other fields:

  -H 'Authorization: Apikey <apikey>' \
  -H 'X-Fields: {orgs{tenant},*}'

# Select

For the data endpoint, we recomment you use the select parameter instead of using the X-Fields header.

Select is a comma-separated string of requested column names with the default being to return all columns. Depending on the size of the time window you are searching, filtering by columns can have a noticeable impact on the amount of data you receive from the API.

# Usage

For example, if you are interested in only temperature, humidity, and precipitation, you could make the following request:

curl -i \
  -G https://api.arable.cloud/api/v2/data/hourly \
  -H "Authorization: Apikey <apikey>" \
  -H "Accept: text/csv" \
  -d "select=time,tair,rh,precip" \
  -d "device=A123456"

More examples can be found in Requesting Data in the /data documentation.

← Errors →