To optimize the user experience for our Core API users, we have implemented pagination and filtering mechanisms to provide more efficient and convenient access to large datasets.
Pagination
For large dataset requests, responses are paginated to ensure manageable and swift data retrieval. To fetch all pages sequentially, use the number parameter, as indicated by the totalPages property. You can set the size parameter (max 200) to determine the number of results per page. If not specified, the default value is 25.
Filtering Parameters
Measurabl’s Core API leverages RSQL logical and comparison operators to support parameterized filtering of entries for most available endpoints. This enables users to retrieve data based on specific conditions, allowing for more focused and efficient querying.
Comparison Operators
Operator | Meaning | Description | Example |
== | Equals | Returns rows where the specified column values exactly equal the query value. |
?filter=name=='10 Main Street' ?filter=name=='10 Main*' ?filter=name=='10 main*' |
=like= | Like | Returns rows where the specified column values are similar to the query value, using wildcard matching. | ?filter=addressLine1=like='Main Street' |
=in= | In | Returns rows where the specified column values match one of the values provided in the query (valueA OR valueB). |
?filter=percentOwned=in='20, 50' ?filter=primaryPropertyType=in=('Financial Office', 'Data Center') |
=out= | Not in | Returns rows where the specified column values do not match any of the values provided in the query (neither valueA nor valueB). | ?filter=addressCountry=out=('United States', 'Germany') |
!= | Not equals | Returns rows where the specified column values do not equal the query value. | ?filter=percentOwned!='100' |
=notlike= | Not like | Returns rows where the specified column values are not similar to the query value, using wildcard matching. | ?filter=addressCountry=notlike='United Kingdom' |
< or =lt= | Lesser than | Returns rows where the specified column values are lesser than the query value. |
?filter=floorAreaSqFt=lt=50000 ?filter=floorAreaSqFt<50000 |
<= or =le= | Lesser than or equal to | Returns rows where the specified column values are lesser than or equal to the query value. |
?filter=floorAreaSqFt=le=50000 ?filter=floorAreaSqFt<=50000 |
> or =gt= | Greater than | Returns rows where the specified column values are greater than the query value. | ?filter=floorAreaSqFt=gt=50000 ?filter=floorAreaSqFt>50000 |
>= or =ge= | Greater than or equal to | Returns rows where the specified column values are greater than or equal to the query value. | ?filter=floorAreaSqFt=ge=50000 ?filter=floorAreaSqFt>=50000 |
Logical Operators
Operator | Meaning | Description | Example |
; or and | Logical AND | Combines multiple conditions, returning rows that meet all the specified conditions simultaneously. |
?filter=addressState=='CA' and floorAreaSqFt<='100000' and yearBuilt>='1950' ?filter=addressState=='CA';floorAreaSqFt<='100000';yearBuilt>='1950' |
, or or | Logical OR | Combines multiple conditions, returning rows that meet at least one of the specified conditions. |
?filter=addressState==CA or (addressZip=in=(10001,10017,10177) and addressState==NY) ?filter=addressState==CA,(addressZip=in=(10001,10017,10177);addressState==NY) |
By using these pagination and filtering features, Core API users can conveniently access and navigate the data they need, leading to a more streamlined and efficient experience.