Skip to content
Sitemark Developer Documentation

Filtering & query parameters

Filter Parameters

Section titled “Filter Parameters”

All filter parameters in the external API accept both single values and arrays. You can use any of these syntaxes based on your needs:

Single Value Syntax:

  • ?param=value1 - Filter by a single value

Multiple Values Syntax:

  • ?param=value1&param=value2&param=value3 - Filter by multiple values (without brackets)
  • ?param[]=value1&param[]=value2&param[]=value3 - Filter by multiple values (with brackets)

Examples:

Terminal window
# Filter by single operation ID
?operation_id=123


# Filter by no operation ID
?operation_id=


# Filter by multiple operation IDs (without brackets)
?operation_id=123&operation_id=456&operation_id=789


# Filter by multiple operation IDs (with brackets)
?operation_id[]=123&operation_id[]=456&operation_id[]=789
?operation_id[]=123&operation_id[]=


# Combine different filter types
?site_id=100&semantic_type=SOLAR_PANELS
?site_id=100&site_id=200&semantic_type=SOLAR_PANELS
?site_id=&site_id=200&semantic_type=SOLAR_PANELS
?site_id[]=100&site_id[]=200&semantic_type[]=SOLAR_PANELS
?site_id[]=&site_id[]=200&semantic_type[]=SOLAR_PANELS

Important Notes:

  • Single value and multiple value syntax (with or without brackets) are all supported
  • The brackets [] are optional when specifying multiple values
  • Null values can be specified by omitting the value after the equals sign (e.g., ?param= or ?param[]=) to filter for records without an associated value
  • Multiple values for the same parameter create an “OR” condition
  • Different parameter types are combined with “AND” logic