List consumer filterable export fields
List consumer filterable export fields › Request Body
Optional category to narrow the result to. Omit to return all fields. See FilterFieldConfig.category.
enabled_onlyWhen true (default), only fields with enabled=true are returned. Pass false to include disabled fields too — useful for an admin view that toggles availability.
List consumer filterable export fields › Responses
Successful Response
Filterable fields, ordered by category then label. Use the name of any entry as the field in a ConsumerFilter or BusinessFilter predicate, respectively. For autofill, pass it to /intent/feeds/filters/consumer/values or /intent/feeds/filters/business/values, matching the fields endpoint.
categoriesDistinct categories present in fields, in declaration order. Convenience for grouping in the UI without having to do a second pass over fields.
Autofill: distinct consumer values for a filterable field
Autofill: distinct consumer values for a filterable field › Request Body
fieldPublic filter key to enumerate values for. Must match the name of an enabled FilterFieldConfig.
Optional autofill query. Case-insensitive substring match for string fields; prefix match against toString(value) for numeric fields. Leave empty to list values without filtering.
limitMaximum number of distinct values to return per call.
offsetOffset-based pagination. Ignored when cursor is also set.
Cursor-based pagination. Pass the last value from the previous page (i.e. the last entry of values) to fetch the next page without paying the OFFSET cost. Mutually exclusive with offset.
Autofill: distinct consumer values for a filterable field › Responses
Successful Response
fieldEchoed field from the request for client-side correlation.
Distinct values found for the requested column, ordered ascending. String values are returned as-is; numeric values as JSON numbers.
has_moretrue when the query produced exactly limit results — the caller should request the next page with next_offset or next_cursor to confirm and continue paginating.
Next offset to use for offset-mode pagination. null when the caller used cursor-mode or has_more is false.
Next cursor to use for cursor-mode pagination — equal to the last entry in values when has_more is true. null when there are no more results.
List business filterable export fields
List business filterable export fields › Request Body
Optional category to narrow the result to. Omit to return all fields. See FilterFieldConfig.category.
enabled_onlyWhen true (default), only fields with enabled=true are returned. Pass false to include disabled fields too — useful for an admin view that toggles availability.
List business filterable export fields › Responses
Successful Response
Filterable fields, ordered by category then label. Use the name of any entry as the field in a ConsumerFilter or BusinessFilter predicate, respectively. For autofill, pass it to /intent/feeds/filters/consumer/values or /intent/feeds/filters/business/values, matching the fields endpoint.
categoriesDistinct categories present in fields, in declaration order. Convenience for grouping in the UI without having to do a second pass over fields.
Autofill: distinct business values for a filterable field
Autofill: distinct business values for a filterable field › Request Body
fieldPublic filter key to enumerate values for. Must match the name of an enabled FilterFieldConfig.
Optional autofill query. Case-insensitive substring match for string fields; prefix match against toString(value) for numeric fields. Leave empty to list values without filtering.
limitMaximum number of distinct values to return per call.
offsetOffset-based pagination. Ignored when cursor is also set.
Cursor-based pagination. Pass the last value from the previous page (i.e. the last entry of values) to fetch the next page without paying the OFFSET cost. Mutually exclusive with offset.
Autofill: distinct business values for a filterable field › Responses
Successful Response
fieldEchoed field from the request for client-side correlation.
Distinct values found for the requested column, ordered ascending. String values are returned as-is; numeric values as JSON numbers.
has_moretrue when the query produced exactly limit results — the caller should request the next page with next_offset or next_cursor to confirm and continue paginating.
Next offset to use for offset-mode pagination. null when the caller used cursor-mode or has_more is false.
Next cursor to use for cursor-mode pagination — equal to the last entry in values when has_more is true. null when there are no more results.