Home > widget-integration > FilterAPIParams

FilterAPIParams type

URL parameters sent to the Boost filter API.

Key-value pairs representing filter selections, sorting, pagination, and other query parameters. Values can be arrays for multi-select filters or primitives for single-select options.

Signature:

export type FilterAPIParams = {
	[key: string]: any[] | string | number | boolean | undefined;
};

Example

const params: FilterAPIParams = {
  pf_st_color: ['red', 'blue'],  // Multi-select color filter
  pf_st_size: 'large',           // Single-select size
  sort_by: 'price-ascending',
  page: 2,
  limit: 24
};