Type Alias FieldCondition

FieldCondition: {
    boolean?: boolean | null;
    date_range?: DateRange | null;
    field: string;
    geo_bounding_box?: LocationBoundingBox | null;
    geo_polygon?: LocationPolygon | null;
    geo_radius?: LocationRadius | null;
    match_all?: MatchCondition[] | null;
    match_any?: MatchCondition[] | null;
    range?: Range | null;
}

FieldCondition is a JSON object which can be used to filter chunks by a field. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with metadata..

Type declaration

  • Optionalboolean?: boolean | null

    Boolean is a true false value for a field. This only works for boolean fields. You can specify this if you want values to be true or false.

  • Optionaldate_range?: DateRange | null
  • field: string

    Field is the name of the field to filter on. Commonly used fields are timestamp, link, tag_set, location, num_value, group_ids, and group_tracking_ids. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with metadata..

  • Optionalgeo_bounding_box?: LocationBoundingBox | null
  • Optionalgeo_polygon?: LocationPolygon | null
  • Optionalgeo_radius?: LocationRadius | null
  • Optionalmatch_all?: MatchCondition[] | null

    Match all lets you pass in an array of values that will return results if all of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used.

  • Optionalmatch_any?: MatchCondition[] | null

    Match any lets you pass in an array of values that will return results if any of the items match. The match value will be used to check for an exact substring match on the metadata values for each existing chunk. If both match_all and match_any are provided, the match_any condition will be used.

  • Optionalrange?: Range | null

Settings

Member Visibility