Query parameters

• charset string

  The text's character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, UTF-8, UTF-16LE, windows-1252, or EUC-JP. If this parameter is not specified, the structure finder chooses an appropriate character set.

• column_names string

  If you have set format to delimited, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example.

• delimiter string

  If you have set format to delimited, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (|). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.

• ecs_compatibility string

  The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are disabled and v1. This setting primarily has an impact when a whole message Grok pattern such as %{CATALINALOG} matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as path, ipaddress, field1, and field2 are used in the grok_pattern output, with the intention that a user who knows the meanings rename these fields before using it.

• explain boolean

  If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.

• format string

  The high level structure of the text. Valid values are ndjson, xml, delimited, and semi_structured_text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row.

• grok_pattern string

  If you have set format to semi_structured_text, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the timestamp_field parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If grok_pattern is not specified, the structure finder creates a Grok pattern.

• has_header_row boolean

  If you have set format to delimited, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows.

• line_merge_size_limit number

  The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected.

• lines_to_sample number

  The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2. If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.

  NOTE: The number of lines and the variation of the lines affects the speed of the analysis. For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety.

• quote string

  If you have set format to delimited, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote ("). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample.

• should_trim_fields boolean

  If you have set format to delimited, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (|), the default value is true. Otherwise, the default value is false.

• timeout string

  The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires then it will be stopped.

  Values are -1 or 0.

• timestamp_field string

  The name of the field that contains the primary timestamp of each record in the text. In particular, if the text were ingested into an index, this is the field that would be used to populate the @timestamp field.

  If the format is semi_structured_text, this field must match the name of the appropriate extraction in the grok_pattern. Therefore, for semi-structured text, it is best not to specify this parameter unless grok_pattern is also specified.

  For structured text, if you specify this parameter, the field must exist within the text.

  If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text.

• timestamp_format string

  The Java time format of the timestamp field in the text.

  Only a subset of Java time format letter groups are supported:

  • a
  • d
  • dd
  • EEE
  • EEEE
  • H
  • HH
  • h
  • M
  • MM
  • MMM
  • MMMM
  • mm
  • ss
  • XX
  • XXX
  • yy
  • yyyy
  • zzz

  Additionally S letter groups (fractional seconds) of length one to nine are supported providing they occur after ss and separated from the ss by a ., , or :. Spacing and punctuation is also permitted with the exception of ?, newline and carriage return, together with literal text enclosed in single quotes. For example, MM/dd HH.mm.ss,SSSSSS 'in' yyyy is a valid override format.

  One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full grok_pattern. Another is when the timestamp format is one that the structure finder does not consider by default.

  If this parameter is not specified, the structure finder chooses the best format from a built-in set.

  If the special value null is specified the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text this will result in the structure finder treating the text as single-line messages.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • charset string Required

    The character encoding used to parse the text.

  • has_header_row boolean
  • has_byte_order_marker boolean Required

    For UTF character encodings, it indicates whether the text begins with a byte order marker.

  • format string Required

    Valid values include ndjson, xml, delimited, and semi_structured_text.

  • field_stats object Required

    The most common values of each field, plus basic numeric statistics for the numeric page_count field. This information may provide clues that the data needs to be cleaned or transformed prior to use by other Elastic Stack functionality.

    Hide field_stats attribute Show field_stats attribute object

    • * object Additional properties
      Hide * attributes Show * attributes object

      • count number Required
      • cardinality number Required
      • top_hits array[object] Required
        Hide top_hits attributes Show top_hits attributes object

        • count number Required
        • value object Required
      • mean_value number
      • median_value number
      • max_value number
      • min_value number
      • earliest string
      • latest string
  • sample_start string Required

    The first two messages in the text verbatim. This may help diagnose parse errors or accidental uploads of the wrong text.

  • num_messages_analyzed number Required

    The number of distinct messages the lines contained. For NDJSON, this value is the same as num_lines_analyzed. For other text formats, messages can span several lines.

  • mappings object Required

    Some suitable mappings for an index into which the data could be ingested.

    Hide mappings attributes Show mappings attributes object

    • all_field object
      Hide all_field attributes Show all_field attributes object

      • analyzer string Required
      • enabled boolean Required
      • omit_norms boolean Required
      • search_analyzer string Required
      • similarity string Required
      • store boolean Required
      • store_term_vector_offsets boolean Required
      • store_term_vector_payloads boolean Required
      • store_term_vector_positions boolean Required
      • store_term_vectors boolean Required
    • date_detection boolean
    • dynamic string

      Values are strict, runtime, true, or false.

    • dynamic_date_formats array[string]
    • dynamic_templates array[object]
    • _field_names object
      Hide _field_names attribute Show _field_names attribute object

      • enabled boolean Required
    • index_field object
      Hide index_field attribute Show index_field attribute object

      • enabled boolean Required
    • _meta object
      Hide _meta attribute Show _meta attribute object

      • * object Additional properties
    • numeric_detection boolean
    • properties object
    • _routing object
      Hide _routing attribute Show _routing attribute object

      • required boolean Required
    • _size object
      Hide _size attribute Show _size attribute object

      • enabled boolean Required
    • _source object
      Hide _source attributes Show _source attributes object

      • compress boolean
      • compress_threshold string
      • enabled boolean
      • excludes array[string]
      • includes array[string]
      • mode string

        Supported values include:

        • disabled
        • stored
        • synthetic: Instead of storing source documents on disk exactly as you send them, Elasticsearch can reconstruct source content on the fly upon retrieval.

        Values are disabled, stored, or synthetic.

    • runtime object
      Hide runtime attribute Show runtime attribute object

      • * object Additional properties
        Hide * attributes Show * attributes object

        • fields object

          For type composite

          Hide fields attribute Show fields attribute object

          • * object Additional properties
        • fetch_fields array[object]

          For type lookup
        • format string

          A custom format for date type runtime fields.

        • input_field string

          For type lookup

        • target_field string

          For type lookup

        • target_index string

          For type lookup

        • script object

          Painless script executed at query time.

        • type string Required

          Field type, which can be: boolean, composite, date, double, geo_point, ip,keyword, long, or lookup.

          Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

    • enabled boolean
    • subobjects string

      Values are true or false.

    • _data_stream_timestamp object
      Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

      • enabled boolean Required
  • quote string
  • delimiter string
  • need_client_timezone boolean Required

    If a timestamp format is detected that does not include a timezone, need_client_timezone is true. The server that parses the text must therefore be told the correct timezone by the client.

  • num_lines_analyzed number Required

    The number of lines of the text that were analyzed.

  • column_names array[string]

    If format is delimited, the column_names field lists the column names in the order they appear in the sample.

  • explanation array[string]
  • grok_pattern string
  • multiline_start_pattern string
  • exclude_lines_pattern string
  • java_timestamp_formats array[string]

    The Java time formats recognized in the time fields. Elasticsearch mappings and ingest pipelines use this format.

  • joda_timestamp_formats array[string]

    Information that is used to tell Logstash how to parse timestamps.

  • timestamp_field string

    The field considered most likely to be the primary timestamp of each document.

  • should_trim_fields boolean
  • ingest_pipeline object Required
    Hide ingest_pipeline attributes Show ingest_pipeline attributes object

    • description string

      Description of the ingest pipeline.

    • version number

      Version number used by external systems to track ingest pipelines.

    • processors array[object] Required

      Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified.

      Hide processors attributes Show processors attributes object

      • append
      • attachment
      • bytes
      • circle
      • community_id
      • convert
      • csv
      • date
      • date_index_name
      • dissect
      • dot_expander
      • drop
      • enrich
      • fail
      • fingerprint
      • foreach
      • ip_location
      • geo_grid
      • geoip
      • grok
      • gsub
      • html_strip
      • inference
      • join
      • json
      • kv
      • lowercase
      • network_direction
      • pipeline
      • redact
      • registered_domain
      • remove
      • rename
      • reroute
      • script
      • set
      • set_security_user
      • sort
      • split
      • terminate
      • trim
      • uppercase
      • urldecode
      • uri_parts
      • user_agent