Query for selecting logs analyzed by the historical job.

Hierarchy

  • HistoricalJobQuery

Constructors

Properties

additionalFilters?: string

Additional filters appended to the query at evaluation time.

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

The aggregation type.

correlatedByFields?: string[]

Fields used to correlate results across queries in sequence detection rules.

correlatedQueryIndex?: number

Zero-based index of the query to correlate with in sequence detection rules. Up to 10 queries are supported, so valid values are 0 to 9.

customQueryExtension?: string

Custom query extension used to refine the base query.

Source of events, either logs, audit trail, security signals, or Datadog events. app_sec_spans is deprecated in favor of spans.

datasetIds?: string[]

IDs of reference datasets used by this query.

distinctFields?: string[]

Field for which the cardinality is measured. Sent as an array.

groupByFields?: string[]

Fields to group by.

hasOptionalGroupByFields?: boolean

When false, events without a group-by value are ignored by the query. When true, events with missing group-by fields are processed with N/A, replacing the missing values.

index?: string

Index used to load the data for this query.

indexes?: string[]

Indexes used to load the data for this query. Mutually exclusive with index.

metrics?: string[]

Group of target fields to aggregate over when using the sum, max, geo data, or new value aggregations. The sum, max, and geo data aggregations only accept one value in this list, whereas the new value aggregation accepts up to five values.

name?: string

Name of the query.

query?: string

Query to run on logs.

queryLanguage?: string

Language used to parse the query string.

Generated using TypeDoc