Filters API Documentation¶

Overview¶

The Filters API exposes endpoints that dynamically generate filter values used in dashboards or client applications. These filters include region, location, room, and Neat device filters.

Note: All endpoints require the header:
x-api-key: YOUR_API_KEY_HERE

This documentation includes:

Endpoints – Purpose, request structure, and sample responses.
Additional Notes – Shared filtering logic used across endpoints.

Endpoints¶

Region Filters¶

POST /filters/region¶

Summary: Retrieves available region filter values.
Description:
Accepts a JSON body with any combination of regionName, locationName, and roomName to narrow down results.

Request Body Example:

{
  "locationName": "all",
  "regionName": "all",
  "roomName": "all"
}

Response Example:
```
["EUROPE", "ASIA"]
```

Location Filters¶

POST /filters/location¶

Summary: Retrieves available location filter values.
Description:
Returns a list of locations filtered by regionName, locationName, and/or roomName.

Request Body Example:

{
  "locationName": "all",
  "regionName": "all",
  "roomName": "all"
}

Response Example:
```
["ALCOBENDAS", "MADRID"]
```

GET /filters/location/byzone/{zone}¶

Summary: Retrieves location filters for a specific zone.
Description:
Returns a list of locations belonging to a specific zone.
Path Parameter:
zone (string, required) – The zone name to use in the filter.
Response Example:
```
3
```

Room Filters¶

POST /filters/room¶

Summary: Retrieves available room filter values.
Description:
Returns a list of room names based on regionName, locationName, and/or roomName.

Request Body Example:

{
  "locationName": "all",
  "regionName": "all",
  "roomName": "all"
}

Response Example:

["Alcob_Sala B.09_Neat Board", "Conference Room A"]

Neat Device Filters¶

GET /filters/neatdevices¶

Summary: Retrieves available Neat device filter values.
Description:
Returns a list of unique device serial numbers used to populate device filters.
Response Example:
```
["ND123", "ND456", "ND789"]
```

Additional Notes¶

The following shared filtering logic is applied across filter endpoints (region, location, and room):

When regionName is provided (and not 'all'), results are limited to items associated with that region.
When locationName is provided (and not 'all'), results are limited to items associated with that location.
When roomName is provided (and not 'all'), results are refined to only those connected to that specific room.