Type Alias GFacet

Type Declaration

• field_name: string

• Optionalname?: string

• { size?: number; type: "terms" }
• { missing?: number; type: "sum" | "avg" }
• {
      date_interval: Schemas["DateHistogramFacet"]["date_interval"];
      histogram_range?: { high: string; low: string };
      type: "date_histogram";
  }

  • date_interval: Schemas["DateHistogramFacet"]["date_interval"]

  • Optionalhistogram_range?: { high: string; low: string }

    histogram_range is optional for date_histogram, but when provided, the low and high values must be one of the supported date formats.

    See

    https://docs.globus.org/api/search/mapped_data_types/#date-formats

  • type: "date_histogram"

    date_histogram faceting requires that the field was detected as a date type.

    See

    https://docs.globus.org/api/search/mapped_data_types/#date-formats

• {
      histogram_range: { high: number; low: number };
      size: number;
      type: "numeric_histogram";
  }