API.md

# TS Interface Generator

> Export JSII Compatible Interface from external packages

This repository is an exploration of generating JSII Compatible Interfaces for public packages on NPM.

It has only been tested with the DataDog Typescript API Client package and is not intended for production use.

## Usage

```bash
# install pj dependencies
yarn
# run the export-datadog-interfaces task
npx projen@latest export-datadog-interfaces
# confirm JSII compile works
npx projen@latest compile
```

## How it works

The `export-datadog-interfaces` task uses the `ts-morph` package to parse the DataDog Typescript API Client package and generate a JSII compatible interface for a specific class within the package. It resolves imports and combines all dependencies into a single Typescript source file.

Notes:

- The DataDog API Typescript Client is autogenerated by OpenAPI generator and creates `class` objects only.
- Internal properties such as `attributeTypeMap` are filtered out.
- The `UnparsedObject` type's `_data` property is tagged as internal.

## References

- [Generate RunTypes from TS](https://gist.github.com/skurfuerst/a07ab23c3e40a45f2268f7700ceeceaf)
- [Type FootPrint](https://gist.github.com/zaripych/963fa6584524e5b446b70548dbabbf65)

# API Reference <a name="API Reference" id="api-reference"></a>


## Structs <a name="Structs" id="Structs"></a>

### AlertGraphWidgetDefinition <a name="AlertGraphWidgetDefinition" id="ts-interface-generator.AlertGraphWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.AlertGraphWidgetDefinition.Initializer"></a>

```typescript
import { AlertGraphWidgetDefinition } from 'ts-interface-generator'

const alertGraphWidgetDefinition: AlertGraphWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.alertId">alertId</a></code> | <code>string</code> | ID of the alert to use in the widget. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the alert graph widget. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.vizType">vizType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Whether to display the Alert Graph as a timeseries or a top list. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.title">title</a></code> | <code>string</code> | The title of the widget. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.AlertGraphWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `alertId`<sup>Required</sup> <a name="alertId" id="ts-interface-generator.AlertGraphWidgetDefinition.property.alertId"></a>

```typescript
public readonly alertId: string;
```

- *Type:* string

ID of the alert to use in the widget.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.AlertGraphWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the alert graph widget.

---

##### `vizType`<sup>Required</sup> <a name="vizType" id="ts-interface-generator.AlertGraphWidgetDefinition.property.vizType"></a>

```typescript
public readonly vizType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Whether to display the Alert Graph as a timeseries or a top list.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.AlertGraphWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.AlertGraphWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

The title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.AlertGraphWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.AlertGraphWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### AlertValueWidgetDefinition <a name="AlertValueWidgetDefinition" id="ts-interface-generator.AlertValueWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.AlertValueWidgetDefinition.Initializer"></a>

```typescript
import { AlertValueWidgetDefinition } from 'ts-interface-generator'

const alertValueWidgetDefinition: AlertValueWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.alertId">alertId</a></code> | <code>string</code> | ID of the alert to use in the widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the alert value widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.precision">precision</a></code> | <code>number</code> | Number of decimal to show. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.textAlign">textAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of value in the widget. |
| <code><a href="#ts-interface-generator.AlertValueWidgetDefinition.property.unit">unit</a></code> | <code>string</code> | Unit to display with the value. |

---

##### `alertId`<sup>Required</sup> <a name="alertId" id="ts-interface-generator.AlertValueWidgetDefinition.property.alertId"></a>

```typescript
public readonly alertId: string;
```

- *Type:* string

ID of the alert to use in the widget.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.AlertValueWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the alert value widget.

---

##### `precision`<sup>Optional</sup> <a name="precision" id="ts-interface-generator.AlertValueWidgetDefinition.property.precision"></a>

```typescript
public readonly precision: number;
```

- *Type:* number

Number of decimal to show.

If not defined, will use the raw value.

---

##### `textAlign`<sup>Optional</sup> <a name="textAlign" id="ts-interface-generator.AlertValueWidgetDefinition.property.textAlign"></a>

```typescript
public readonly textAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.AlertValueWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.AlertValueWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.AlertValueWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of value in the widget.

---

##### `unit`<sup>Optional</sup> <a name="unit" id="ts-interface-generator.AlertValueWidgetDefinition.property.unit"></a>

```typescript
public readonly unit: string;
```

- *Type:* string

Unit to display with the value.

---

### ApmStatsQueryColumnType <a name="ApmStatsQueryColumnType" id="ts-interface-generator.ApmStatsQueryColumnType"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ApmStatsQueryColumnType.Initializer"></a>

```typescript
import { ApmStatsQueryColumnType } from 'ts-interface-generator'

const apmStatsQueryColumnType: ApmStatsQueryColumnType = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ApmStatsQueryColumnType.property.name">name</a></code> | <code>string</code> | Column name. |
| <code><a href="#ts-interface-generator.ApmStatsQueryColumnType.property.alias">alias</a></code> | <code>string</code> | A user-assigned alias for the column. |
| <code><a href="#ts-interface-generator.ApmStatsQueryColumnType.property.cellDisplayMode">cellDisplayMode</a></code> | <code>string \| <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a></code> | Define a display mode for the table cell. |
| <code><a href="#ts-interface-generator.ApmStatsQueryColumnType.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.ApmStatsQueryColumnType.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Column name.

---

##### `alias`<sup>Optional</sup> <a name="alias" id="ts-interface-generator.ApmStatsQueryColumnType.property.alias"></a>

```typescript
public readonly alias: string;
```

- *Type:* string

A user-assigned alias for the column.

---

##### `cellDisplayMode`<sup>Optional</sup> <a name="cellDisplayMode" id="ts-interface-generator.ApmStatsQueryColumnType.property.cellDisplayMode"></a>

```typescript
public readonly cellDisplayMode: string | UnparsedObject;
```

- *Type:* string | <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a>

Define a display mode for the table cell.

---

##### `order`<sup>Optional</sup> <a name="order" id="ts-interface-generator.ApmStatsQueryColumnType.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

### ApmStatsQueryDefinition <a name="ApmStatsQueryDefinition" id="ts-interface-generator.ApmStatsQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ApmStatsQueryDefinition.Initializer"></a>

```typescript
import { ApmStatsQueryDefinition } from 'ts-interface-generator'

const apmStatsQueryDefinition: ApmStatsQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.env">env</a></code> | <code>string</code> | Environment name. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.name">name</a></code> | <code>string</code> | Operation name associated with service. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.primaryTag">primaryTag</a></code> | <code>string</code> | The organization's host group name and value. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.rowType">rowType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | The level of detail for the request. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.service">service</a></code> | <code>string</code> | Service name. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.columns">columns</a></code> | <code><a href="#ts-interface-generator.ApmStatsQueryColumnType">ApmStatsQueryColumnType</a>[]</code> | Column properties used by the front end for display. |
| <code><a href="#ts-interface-generator.ApmStatsQueryDefinition.property.resource">resource</a></code> | <code>string</code> | Resource name. |

---

##### `env`<sup>Required</sup> <a name="env" id="ts-interface-generator.ApmStatsQueryDefinition.property.env"></a>

```typescript
public readonly env: string;
```

- *Type:* string

Environment name.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.ApmStatsQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Operation name associated with service.

---

##### `primaryTag`<sup>Required</sup> <a name="primaryTag" id="ts-interface-generator.ApmStatsQueryDefinition.property.primaryTag"></a>

```typescript
public readonly primaryTag: string;
```

- *Type:* string

The organization's host group name and value.

---

##### `rowType`<sup>Required</sup> <a name="rowType" id="ts-interface-generator.ApmStatsQueryDefinition.property.rowType"></a>

```typescript
public readonly rowType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

The level of detail for the request.

---

##### `service`<sup>Required</sup> <a name="service" id="ts-interface-generator.ApmStatsQueryDefinition.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

Service name.

---

##### `columns`<sup>Optional</sup> <a name="columns" id="ts-interface-generator.ApmStatsQueryDefinition.property.columns"></a>

```typescript
public readonly columns: ApmStatsQueryColumnType[];
```

- *Type:* <a href="#ts-interface-generator.ApmStatsQueryColumnType">ApmStatsQueryColumnType</a>[]

Column properties used by the front end for display.

---

##### `resource`<sup>Optional</sup> <a name="resource" id="ts-interface-generator.ApmStatsQueryDefinition.property.resource"></a>

```typescript
public readonly resource: string;
```

- *Type:* string

Resource name.

---

### ChangeWidgetDefinition <a name="ChangeWidgetDefinition" id="ts-interface-generator.ChangeWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ChangeWidgetDefinition.Initializer"></a>

```typescript
import { ChangeWidgetDefinition } from 'ts-interface-generator'

const changeWidgetDefinition: ChangeWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.ChangeWidgetRequest">ChangeWidgetRequest</a>[]</code> | Array of one request object to display in the widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the change widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.ChangeWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: ChangeWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.ChangeWidgetRequest">ChangeWidgetRequest</a>[]

Array of one request object to display in the widget.

See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
 to learn how to build the `REQUEST_SCHEMA`.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ChangeWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the change widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.ChangeWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.ChangeWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ChangeWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ChangeWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ChangeWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### ChangeWidgetRequest <a name="ChangeWidgetRequest" id="ts-interface-generator.ChangeWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ChangeWidgetRequest.Initializer"></a>

```typescript
import { ChangeWidgetRequest } from 'ts-interface-generator'

const changeWidgetRequest: ChangeWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.changeType">changeType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Show the absolute or the relative change. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.compareTo">compareTo</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeframe used for the change comparison. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.increaseGood">increaseGood</a></code> | <code>boolean</code> | Whether to show increase as good. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.orderBy">orderBy</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | What to order by. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.orderDir">orderDir</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.q">q</a></code> | <code>string</code> | Query definition. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ChangeWidgetRequest.property.showPresent">showPresent</a></code> | <code>boolean</code> | Whether to show the present value. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.ChangeWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `changeType`<sup>Optional</sup> <a name="changeType" id="ts-interface-generator.ChangeWidgetRequest.property.changeType"></a>

```typescript
public readonly changeType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Show the absolute or the relative change.

---

##### `compareTo`<sup>Optional</sup> <a name="compareTo" id="ts-interface-generator.ChangeWidgetRequest.property.compareTo"></a>

```typescript
public readonly compareTo: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeframe used for the change comparison.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.ChangeWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.ChangeWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `increaseGood`<sup>Optional</sup> <a name="increaseGood" id="ts-interface-generator.ChangeWidgetRequest.property.increaseGood"></a>

```typescript
public readonly increaseGood: boolean;
```

- *Type:* boolean

Whether to show increase as good.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.ChangeWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.ChangeWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `orderBy`<sup>Optional</sup> <a name="orderBy" id="ts-interface-generator.ChangeWidgetRequest.property.orderBy"></a>

```typescript
public readonly orderBy: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

What to order by.

---

##### `orderDir`<sup>Optional</sup> <a name="orderDir" id="ts-interface-generator.ChangeWidgetRequest.property.orderDir"></a>

```typescript
public readonly orderDir: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.ChangeWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.ChangeWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.ChangeWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Query definition.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.ChangeWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.ChangeWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.ChangeWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.ChangeWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `showPresent`<sup>Optional</sup> <a name="showPresent" id="ts-interface-generator.ChangeWidgetRequest.property.showPresent"></a>

```typescript
public readonly showPresent: boolean;
```

- *Type:* boolean

Whether to show the present value.

---

### CheckStatusWidgetDefinition <a name="CheckStatusWidgetDefinition" id="ts-interface-generator.CheckStatusWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.CheckStatusWidgetDefinition.Initializer"></a>

```typescript
import { CheckStatusWidgetDefinition } from 'ts-interface-generator'

const checkStatusWidgetDefinition: CheckStatusWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.check">check</a></code> | <code>string</code> | Name of the check to use in the widget. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.grouping">grouping</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | The kind of grouping to use. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the check status widget. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.group">group</a></code> | <code>string</code> | Group reporting a single check. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.groupBy">groupBy</a></code> | <code>string[]</code> | List of tag prefixes to group by in the case of a cluster check. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.tags">tags</a></code> | <code>string[]</code> | List of tags used to filter the groups reporting a cluster check. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.CheckStatusWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `check`<sup>Required</sup> <a name="check" id="ts-interface-generator.CheckStatusWidgetDefinition.property.check"></a>

```typescript
public readonly check: string;
```

- *Type:* string

Name of the check to use in the widget.

---

##### `grouping`<sup>Required</sup> <a name="grouping" id="ts-interface-generator.CheckStatusWidgetDefinition.property.grouping"></a>

```typescript
public readonly grouping: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

The kind of grouping to use.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.CheckStatusWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the check status widget.

---

##### `group`<sup>Optional</sup> <a name="group" id="ts-interface-generator.CheckStatusWidgetDefinition.property.group"></a>

```typescript
public readonly group: string;
```

- *Type:* string

Group reporting a single check.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.CheckStatusWidgetDefinition.property.groupBy"></a>

```typescript
public readonly groupBy: string[];
```

- *Type:* string[]

List of tag prefixes to group by in the case of a cluster check.

---

##### `tags`<sup>Optional</sup> <a name="tags" id="ts-interface-generator.CheckStatusWidgetDefinition.property.tags"></a>

```typescript
public readonly tags: string[];
```

- *Type:* string[]

List of tags used to filter the groups reporting a cluster check.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.CheckStatusWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.CheckStatusWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.CheckStatusWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.CheckStatusWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### Dashboard <a name="Dashboard" id="ts-interface-generator.Dashboard"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.Dashboard.Initializer"></a>

```typescript
import { Dashboard } from 'ts-interface-generator'

const dashboard: Dashboard = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.Dashboard.property.layoutType">layoutType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Layout type of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.title">title</a></code> | <code>string</code> | Title of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.widgets">widgets</a></code> | <code><a href="#ts-interface-generator.Widget">Widget</a>[]</code> | List of widgets to display on the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.authorHandle">authorHandle</a></code> | <code>string</code> | Identifier of the dashboard author. |
| <code><a href="#ts-interface-generator.Dashboard.property.authorName">authorName</a></code> | <code>string</code> | Name of the dashboard author. |
| <code><a href="#ts-interface-generator.Dashboard.property.createdAt">createdAt</a></code> | <code>Date</code> | Creation date of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.description">description</a></code> | <code>string</code> | Description of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.id">id</a></code> | <code>string</code> | ID of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.isReadOnly">isReadOnly</a></code> | <code>boolean</code> | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. |
| <code><a href="#ts-interface-generator.Dashboard.property.modifiedAt">modifiedAt</a></code> | <code>Date</code> | Modification date of the dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.notifyList">notifyList</a></code> | <code>string[]</code> | List of handles of users to notify when changes are made to this dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.reflowType">reflowType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Reflow type for a **new dashboard layout** dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.restrictedRoles">restrictedRoles</a></code> | <code>string[]</code> | A list of role identifiers. |
| <code><a href="#ts-interface-generator.Dashboard.property.tags">tags</a></code> | <code>string[]</code> | List of team names representing ownership of a dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.templateVariablePresets">templateVariablePresets</a></code> | <code><a href="#ts-interface-generator.DashboardTemplateVariablePreset">DashboardTemplateVariablePreset</a>[]</code> | Array of template variables saved views. |
| <code><a href="#ts-interface-generator.Dashboard.property.templateVariables">templateVariables</a></code> | <code><a href="#ts-interface-generator.DashboardTemplateVariable">DashboardTemplateVariable</a>[]</code> | List of template variables for this dashboard. |
| <code><a href="#ts-interface-generator.Dashboard.property.url">url</a></code> | <code>string</code> | The URL of the dashboard. |

---

##### `layoutType`<sup>Required</sup> <a name="layoutType" id="ts-interface-generator.Dashboard.property.layoutType"></a>

```typescript
public readonly layoutType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Layout type of the dashboard.

---

##### `title`<sup>Required</sup> <a name="title" id="ts-interface-generator.Dashboard.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the dashboard.

---

##### `widgets`<sup>Required</sup> <a name="widgets" id="ts-interface-generator.Dashboard.property.widgets"></a>

```typescript
public readonly widgets: Widget[];
```

- *Type:* <a href="#ts-interface-generator.Widget">Widget</a>[]

List of widgets to display on the dashboard.

---

##### `authorHandle`<sup>Optional</sup> <a name="authorHandle" id="ts-interface-generator.Dashboard.property.authorHandle"></a>

```typescript
public readonly authorHandle: string;
```

- *Type:* string

Identifier of the dashboard author.

---

##### `authorName`<sup>Optional</sup> <a name="authorName" id="ts-interface-generator.Dashboard.property.authorName"></a>

```typescript
public readonly authorName: string;
```

- *Type:* string

Name of the dashboard author.

---

##### `createdAt`<sup>Optional</sup> <a name="createdAt" id="ts-interface-generator.Dashboard.property.createdAt"></a>

```typescript
public readonly createdAt: Date;
```

- *Type:* Date

Creation date of the dashboard.

---

##### `description`<sup>Optional</sup> <a name="description" id="ts-interface-generator.Dashboard.property.description"></a>

```typescript
public readonly description: string;
```

- *Type:* string

Description of the dashboard.

---

##### `id`<sup>Optional</sup> <a name="id" id="ts-interface-generator.Dashboard.property.id"></a>

```typescript
public readonly id: string;
```

- *Type:* string

ID of the dashboard.

---

##### `isReadOnly`<sup>Optional</sup> <a name="isReadOnly" id="ts-interface-generator.Dashboard.property.isReadOnly"></a>

```typescript
public readonly isReadOnly: boolean;
```

- *Type:* boolean

Whether this dashboard is read-only. If True, only the author and admins can make changes to it.

This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.

---

##### `modifiedAt`<sup>Optional</sup> <a name="modifiedAt" id="ts-interface-generator.Dashboard.property.modifiedAt"></a>

```typescript
public readonly modifiedAt: Date;
```

- *Type:* Date

Modification date of the dashboard.

---

##### `notifyList`<sup>Optional</sup> <a name="notifyList" id="ts-interface-generator.Dashboard.property.notifyList"></a>

```typescript
public readonly notifyList: string[];
```

- *Type:* string[]

List of handles of users to notify when changes are made to this dashboard.

---

##### `reflowType`<sup>Optional</sup> <a name="reflowType" id="ts-interface-generator.Dashboard.property.reflowType"></a>

```typescript
public readonly reflowType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Reflow type for a **new dashboard layout** dashboard.

Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.

---

##### `restrictedRoles`<sup>Optional</sup> <a name="restrictedRoles" id="ts-interface-generator.Dashboard.property.restrictedRoles"></a>

```typescript
public readonly restrictedRoles: string[];
```

- *Type:* string[]

A list of role identifiers.

Only the author and users associated with at least one of these roles can edit this dashboard.

This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.

---

##### `tags`<sup>Optional</sup> <a name="tags" id="ts-interface-generator.Dashboard.property.tags"></a>

```typescript
public readonly tags: string[];
```

- *Type:* string[]

List of team names representing ownership of a dashboard.

---

##### `templateVariablePresets`<sup>Optional</sup> <a name="templateVariablePresets" id="ts-interface-generator.Dashboard.property.templateVariablePresets"></a>

```typescript
public readonly templateVariablePresets: DashboardTemplateVariablePreset[];
```

- *Type:* <a href="#ts-interface-generator.DashboardTemplateVariablePreset">DashboardTemplateVariablePreset</a>[]

Array of template variables saved views.

---

##### `templateVariables`<sup>Optional</sup> <a name="templateVariables" id="ts-interface-generator.Dashboard.property.templateVariables"></a>

```typescript
public readonly templateVariables: DashboardTemplateVariable[];
```

- *Type:* <a href="#ts-interface-generator.DashboardTemplateVariable">DashboardTemplateVariable</a>[]

List of template variables for this dashboard.

---

##### `url`<sup>Optional</sup> <a name="url" id="ts-interface-generator.Dashboard.property.url"></a>

```typescript
public readonly url: string;
```

- *Type:* string

The URL of the dashboard.

---

### DashboardTemplateVariable <a name="DashboardTemplateVariable" id="ts-interface-generator.DashboardTemplateVariable"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DashboardTemplateVariable.Initializer"></a>

```typescript
import { DashboardTemplateVariable } from 'ts-interface-generator'

const dashboardTemplateVariable: DashboardTemplateVariable = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DashboardTemplateVariable.property.name">name</a></code> | <code>string</code> | The name of the variable. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariable.property.availableValues">availableValues</a></code> | <code>string[]</code> | The list of values that the template variable drop-down is limited to. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariable.property.defaults">defaults</a></code> | <code>string[]</code> | One or many default values for template variables on load. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariable.property.prefix">prefix</a></code> | <code>string</code> | The tag prefix associated with the variable. |

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.DashboardTemplateVariable.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

The name of the variable.

---

##### `availableValues`<sup>Optional</sup> <a name="availableValues" id="ts-interface-generator.DashboardTemplateVariable.property.availableValues"></a>

```typescript
public readonly availableValues: string[];
```

- *Type:* string[]

The list of values that the template variable drop-down is limited to.

---

##### `defaults`<sup>Optional</sup> <a name="defaults" id="ts-interface-generator.DashboardTemplateVariable.property.defaults"></a>

```typescript
public readonly defaults: string[];
```

- *Type:* string[]

One or many default values for template variables on load.

If more than one default is specified, they will be unioned together with `OR`. Cannot be used in conjunction with `default`.

---

##### `prefix`<sup>Optional</sup> <a name="prefix" id="ts-interface-generator.DashboardTemplateVariable.property.prefix"></a>

```typescript
public readonly prefix: string;
```

- *Type:* string

The tag prefix associated with the variable.

Only tags with this prefix appear in the variable drop-down.

---

### DashboardTemplateVariablePreset <a name="DashboardTemplateVariablePreset" id="ts-interface-generator.DashboardTemplateVariablePreset"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DashboardTemplateVariablePreset.Initializer"></a>

```typescript
import { DashboardTemplateVariablePreset } from 'ts-interface-generator'

const dashboardTemplateVariablePreset: DashboardTemplateVariablePreset = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DashboardTemplateVariablePreset.property.name">name</a></code> | <code>string</code> | The name of the variable. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariablePreset.property.templateVariables">templateVariables</a></code> | <code><a href="#ts-interface-generator.DashboardTemplateVariablePresetValue">DashboardTemplateVariablePresetValue</a>[]</code> | List of variables. |

---

##### `name`<sup>Optional</sup> <a name="name" id="ts-interface-generator.DashboardTemplateVariablePreset.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

The name of the variable.

---

##### `templateVariables`<sup>Optional</sup> <a name="templateVariables" id="ts-interface-generator.DashboardTemplateVariablePreset.property.templateVariables"></a>

```typescript
public readonly templateVariables: DashboardTemplateVariablePresetValue[];
```

- *Type:* <a href="#ts-interface-generator.DashboardTemplateVariablePresetValue">DashboardTemplateVariablePresetValue</a>[]

List of variables.

---

### DashboardTemplateVariablePresetValue <a name="DashboardTemplateVariablePresetValue" id="ts-interface-generator.DashboardTemplateVariablePresetValue"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DashboardTemplateVariablePresetValue.Initializer"></a>

```typescript
import { DashboardTemplateVariablePresetValue } from 'ts-interface-generator'

const dashboardTemplateVariablePresetValue: DashboardTemplateVariablePresetValue = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DashboardTemplateVariablePresetValue.property.name">name</a></code> | <code>string</code> | The name of the variable. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariablePresetValue.property.value">value</a></code> | <code>string</code> | (deprecated) The value of the template variable within the saved view. |
| <code><a href="#ts-interface-generator.DashboardTemplateVariablePresetValue.property.values">values</a></code> | <code>string[]</code> | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. |

---

##### `name`<sup>Optional</sup> <a name="name" id="ts-interface-generator.DashboardTemplateVariablePresetValue.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

The name of the variable.

---

##### `value`<sup>Optional</sup> <a name="value" id="ts-interface-generator.DashboardTemplateVariablePresetValue.property.value"></a>

```typescript
public readonly value: string;
```

- *Type:* string

(deprecated) The value of the template variable within the saved view.

Cannot be used in conjunction with `values`.

---

##### `values`<sup>Optional</sup> <a name="values" id="ts-interface-generator.DashboardTemplateVariablePresetValue.property.values"></a>

```typescript
public readonly values: string[];
```

- *Type:* string[]

One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.

Cannot be used in conjunction with `value`.

---

### DistributionWidgetDefinition <a name="DistributionWidgetDefinition" id="ts-interface-generator.DistributionWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DistributionWidgetDefinition.Initializer"></a>

```typescript
import { DistributionWidgetDefinition } from 'ts-interface-generator'

const distributionWidgetDefinition: DistributionWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.DistributionWidgetRequest">DistributionWidgetRequest</a>[]</code> | Array of one request object to display in the widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the distribution widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | A list of custom links. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.legendSize">legendSize</a></code> | <code>string</code> | (Deprecated) The widget legend was replaced by a tooltip and sidebar. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.markers">markers</a></code> | <code><a href="#ts-interface-generator.WidgetMarker">WidgetMarker</a>[]</code> | List of markers. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.showLegend">showLegend</a></code> | <code>boolean</code> | (Deprecated) The widget legend was replaced by a tooltip and sidebar. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.xaxis">xaxis</a></code> | <code><a href="#ts-interface-generator.DistributionWidgetXAxis">DistributionWidgetXAxis</a></code> | X Axis controls for the distribution widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetDefinition.property.yaxis">yaxis</a></code> | <code><a href="#ts-interface-generator.DistributionWidgetYAxis">DistributionWidgetYAxis</a></code> | Y Axis controls for the distribution widget. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.DistributionWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: DistributionWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.DistributionWidgetRequest">DistributionWidgetRequest</a>[]

Array of one request object to display in the widget.

See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
 to learn how to build the `REQUEST_SCHEMA`.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.DistributionWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the distribution widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.DistributionWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

A list of custom links.

---

##### `legendSize`<sup>Optional</sup> <a name="legendSize" id="ts-interface-generator.DistributionWidgetDefinition.property.legendSize"></a>

```typescript
public readonly legendSize: string;
```

- *Type:* string

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

---

##### `markers`<sup>Optional</sup> <a name="markers" id="ts-interface-generator.DistributionWidgetDefinition.property.markers"></a>

```typescript
public readonly markers: WidgetMarker[];
```

- *Type:* <a href="#ts-interface-generator.WidgetMarker">WidgetMarker</a>[]

List of markers.

---

##### `showLegend`<sup>Optional</sup> <a name="showLegend" id="ts-interface-generator.DistributionWidgetDefinition.property.showLegend"></a>

```typescript
public readonly showLegend: boolean;
```

- *Type:* boolean

(Deprecated) The widget legend was replaced by a tooltip and sidebar.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.DistributionWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.DistributionWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.DistributionWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.DistributionWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

##### `xaxis`<sup>Optional</sup> <a name="xaxis" id="ts-interface-generator.DistributionWidgetDefinition.property.xaxis"></a>

```typescript
public readonly xaxis: DistributionWidgetXAxis;
```

- *Type:* <a href="#ts-interface-generator.DistributionWidgetXAxis">DistributionWidgetXAxis</a>

X Axis controls for the distribution widget.

---

##### `yaxis`<sup>Optional</sup> <a name="yaxis" id="ts-interface-generator.DistributionWidgetDefinition.property.yaxis"></a>

```typescript
public readonly yaxis: DistributionWidgetYAxis;
```

- *Type:* <a href="#ts-interface-generator.DistributionWidgetYAxis">DistributionWidgetYAxis</a>

Y Axis controls for the distribution widget.

---

### DistributionWidgetRequest <a name="DistributionWidgetRequest" id="ts-interface-generator.DistributionWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DistributionWidgetRequest.Initializer"></a>

```typescript
import { DistributionWidgetRequest } from 'ts-interface-generator'

const distributionWidgetRequest: DistributionWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.apmStatsQuery">apmStatsQuery</a></code> | <code><a href="#ts-interface-generator.ApmStatsQueryDefinition">ApmStatsQueryDefinition</a></code> | The APM stats query for table and distributions widgets. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.q">q</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a></code> | Query definition for Distribution Widget Histogram Request. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.requestType">requestType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Request type for the histogram request. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.DistributionWidgetRequest.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a></code> | Widget style definition. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.DistributionWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `apmStatsQuery`<sup>Optional</sup> <a name="apmStatsQuery" id="ts-interface-generator.DistributionWidgetRequest.property.apmStatsQuery"></a>

```typescript
public readonly apmStatsQuery: ApmStatsQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ApmStatsQueryDefinition">ApmStatsQueryDefinition</a>

The APM stats query for table and distributions widgets.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.DistributionWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.DistributionWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.DistributionWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.DistributionWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.DistributionWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.DistributionWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Widget query.

---

##### `query`<sup>Optional</sup> <a name="query" id="ts-interface-generator.DistributionWidgetRequest.property.query"></a>

```typescript
public readonly query: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a>

Query definition for Distribution Widget Histogram Request.

---

##### `requestType`<sup>Optional</sup> <a name="requestType" id="ts-interface-generator.DistributionWidgetRequest.property.requestType"></a>

```typescript
public readonly requestType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Request type for the histogram request.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.DistributionWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.DistributionWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.DistributionWidgetRequest.property.style"></a>

```typescript
public readonly style: WidgetStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a>

Widget style definition.

---

### DistributionWidgetXAxis <a name="DistributionWidgetXAxis" id="ts-interface-generator.DistributionWidgetXAxis"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DistributionWidgetXAxis.Initializer"></a>

```typescript
import { DistributionWidgetXAxis } from 'ts-interface-generator'

const distributionWidgetXAxis: DistributionWidgetXAxis = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DistributionWidgetXAxis.property.includeZero">includeZero</a></code> | <code>boolean</code> | True includes zero. |
| <code><a href="#ts-interface-generator.DistributionWidgetXAxis.property.max">max</a></code> | <code>string</code> | Specifies maximum value to show on the x-axis. |
| <code><a href="#ts-interface-generator.DistributionWidgetXAxis.property.min">min</a></code> | <code>string</code> | Specifies minimum value to show on the x-axis. |
| <code><a href="#ts-interface-generator.DistributionWidgetXAxis.property.scale">scale</a></code> | <code>string</code> | Specifies the scale type. |

---

##### `includeZero`<sup>Optional</sup> <a name="includeZero" id="ts-interface-generator.DistributionWidgetXAxis.property.includeZero"></a>

```typescript
public readonly includeZero: boolean;
```

- *Type:* boolean

True includes zero.

---

##### `max`<sup>Optional</sup> <a name="max" id="ts-interface-generator.DistributionWidgetXAxis.property.max"></a>

```typescript
public readonly max: string;
```

- *Type:* string

Specifies maximum value to show on the x-axis.

It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.

---

##### `min`<sup>Optional</sup> <a name="min" id="ts-interface-generator.DistributionWidgetXAxis.property.min"></a>

```typescript
public readonly min: string;
```

- *Type:* string

Specifies minimum value to show on the x-axis.

It takes a number, percentile (p90 === 90th percentile), or auto for default behavior.

---

##### `scale`<sup>Optional</sup> <a name="scale" id="ts-interface-generator.DistributionWidgetXAxis.property.scale"></a>

```typescript
public readonly scale: string;
```

- *Type:* string

Specifies the scale type.

Possible values are `linear`.

---

### DistributionWidgetYAxis <a name="DistributionWidgetYAxis" id="ts-interface-generator.DistributionWidgetYAxis"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.DistributionWidgetYAxis.Initializer"></a>

```typescript
import { DistributionWidgetYAxis } from 'ts-interface-generator'

const distributionWidgetYAxis: DistributionWidgetYAxis = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.DistributionWidgetYAxis.property.includeZero">includeZero</a></code> | <code>boolean</code> | True includes zero. |
| <code><a href="#ts-interface-generator.DistributionWidgetYAxis.property.label">label</a></code> | <code>string</code> | The label of the axis to display on the graph. |
| <code><a href="#ts-interface-generator.DistributionWidgetYAxis.property.max">max</a></code> | <code>string</code> | Specifies the maximum value to show on the y-axis. |
| <code><a href="#ts-interface-generator.DistributionWidgetYAxis.property.min">min</a></code> | <code>string</code> | Specifies minimum value to show on the y-axis. |
| <code><a href="#ts-interface-generator.DistributionWidgetYAxis.property.scale">scale</a></code> | <code>string</code> | Specifies the scale type. |

---

##### `includeZero`<sup>Optional</sup> <a name="includeZero" id="ts-interface-generator.DistributionWidgetYAxis.property.includeZero"></a>

```typescript
public readonly includeZero: boolean;
```

- *Type:* boolean

True includes zero.

---

##### `label`<sup>Optional</sup> <a name="label" id="ts-interface-generator.DistributionWidgetYAxis.property.label"></a>

```typescript
public readonly label: string;
```

- *Type:* string

The label of the axis to display on the graph.

---

##### `max`<sup>Optional</sup> <a name="max" id="ts-interface-generator.DistributionWidgetYAxis.property.max"></a>

```typescript
public readonly max: string;
```

- *Type:* string

Specifies the maximum value to show on the y-axis.

It takes a number, or auto for default behavior.

---

##### `min`<sup>Optional</sup> <a name="min" id="ts-interface-generator.DistributionWidgetYAxis.property.min"></a>

```typescript
public readonly min: string;
```

- *Type:* string

Specifies minimum value to show on the y-axis.

It takes a number, or auto for default behavior.

---

##### `scale`<sup>Optional</sup> <a name="scale" id="ts-interface-generator.DistributionWidgetYAxis.property.scale"></a>

```typescript
public readonly scale: string;
```

- *Type:* string

Specifies the scale type.

Possible values are `linear` or `log`.

---

### EventQueryDefinition <a name="EventQueryDefinition" id="ts-interface-generator.EventQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.EventQueryDefinition.Initializer"></a>

```typescript
import { EventQueryDefinition } from 'ts-interface-generator'

const eventQueryDefinition: EventQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.EventQueryDefinition.property.search">search</a></code> | <code>string</code> | The query being made on the event. |
| <code><a href="#ts-interface-generator.EventQueryDefinition.property.tagsExecution">tagsExecution</a></code> | <code>string</code> | The execution method for multi-value filters. |

---

##### `search`<sup>Required</sup> <a name="search" id="ts-interface-generator.EventQueryDefinition.property.search"></a>

```typescript
public readonly search: string;
```

- *Type:* string

The query being made on the event.

---

##### `tagsExecution`<sup>Required</sup> <a name="tagsExecution" id="ts-interface-generator.EventQueryDefinition.property.tagsExecution"></a>

```typescript
public readonly tagsExecution: string;
```

- *Type:* string

The execution method for multi-value filters.

Can be either and or or.

---

### EventStreamWidgetDefinition <a name="EventStreamWidgetDefinition" id="ts-interface-generator.EventStreamWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.EventStreamWidgetDefinition.Initializer"></a>

```typescript
import { EventStreamWidgetDefinition } from 'ts-interface-generator'

const eventStreamWidgetDefinition: EventStreamWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.query">query</a></code> | <code>string</code> | Query to filter the event stream with. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the event stream widget. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.eventSize">eventSize</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Size to use to display an event. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.tagsExecution">tagsExecution</a></code> | <code>string</code> | The execution method for multi-value filters. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.EventStreamWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.EventStreamWidgetDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Query to filter the event stream with.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.EventStreamWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the event stream widget.

---

##### `eventSize`<sup>Optional</sup> <a name="eventSize" id="ts-interface-generator.EventStreamWidgetDefinition.property.eventSize"></a>

```typescript
public readonly eventSize: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Size to use to display an event.

---

##### `tagsExecution`<sup>Optional</sup> <a name="tagsExecution" id="ts-interface-generator.EventStreamWidgetDefinition.property.tagsExecution"></a>

```typescript
public readonly tagsExecution: string;
```

- *Type:* string

The execution method for multi-value filters.

Can be either and or or.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.EventStreamWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.EventStreamWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.EventStreamWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.EventStreamWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### EventTimelineWidgetDefinition <a name="EventTimelineWidgetDefinition" id="ts-interface-generator.EventTimelineWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.EventTimelineWidgetDefinition.Initializer"></a>

```typescript
import { EventTimelineWidgetDefinition } from 'ts-interface-generator'

const eventTimelineWidgetDefinition: EventTimelineWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.query">query</a></code> | <code>string</code> | Query to filter the event timeline with. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the event timeline widget. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.tagsExecution">tagsExecution</a></code> | <code>string</code> | The execution method for multi-value filters. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.EventTimelineWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.EventTimelineWidgetDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Query to filter the event timeline with.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.EventTimelineWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the event timeline widget.

---

##### `tagsExecution`<sup>Optional</sup> <a name="tagsExecution" id="ts-interface-generator.EventTimelineWidgetDefinition.property.tagsExecution"></a>

```typescript
public readonly tagsExecution: string;
```

- *Type:* string

The execution method for multi-value filters.

Can be either and or or.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.EventTimelineWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.EventTimelineWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.EventTimelineWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.EventTimelineWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### FormulaAndFunctionApmDependencyStatsQueryDefinition <a name="FormulaAndFunctionApmDependencyStatsQueryDefinition" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionApmDependencyStatsQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionApmDependencyStatsQueryDefinition: FormulaAndFunctionApmDependencyStatsQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for APM dependency stats queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.env">env</a></code> | <code>string</code> | APM environment. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of query to use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.operationName">operationName</a></code> | <code>string</code> | Name of operation on service. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.resourceName">resourceName</a></code> | <code>string</code> | APM resource. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.service">service</a></code> | <code>string</code> | APM service. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.stat">stat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | APM statistic. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.isUpstream">isUpstream</a></code> | <code>boolean</code> | Determines whether stats for upstream or downstream dependencies should be queried. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.primaryTagName">primaryTagName</a></code> | <code>string</code> | The name of the second primary tag used within APM; |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.primaryTagValue">primaryTagValue</a></code> | <code>string</code> | Filter APM data by the second primary tag. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for APM dependency stats queries.

---

##### `env`<sup>Required</sup> <a name="env" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.env"></a>

```typescript
public readonly env: string;
```

- *Type:* string

APM environment.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of query to use in formulas.

---

##### `operationName`<sup>Required</sup> <a name="operationName" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.operationName"></a>

```typescript
public readonly operationName: string;
```

- *Type:* string

Name of operation on service.

---

##### `resourceName`<sup>Required</sup> <a name="resourceName" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.resourceName"></a>

```typescript
public readonly resourceName: string;
```

- *Type:* string

APM resource.

---

##### `service`<sup>Required</sup> <a name="service" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

APM service.

---

##### `stat`<sup>Required</sup> <a name="stat" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.stat"></a>

```typescript
public readonly stat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

APM statistic.

---

##### `isUpstream`<sup>Optional</sup> <a name="isUpstream" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.isUpstream"></a>

```typescript
public readonly isUpstream: boolean;
```

- *Type:* boolean

Determines whether stats for upstream or downstream dependencies should be queried.

---

##### `primaryTagName`<sup>Optional</sup> <a name="primaryTagName" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.primaryTagName"></a>

```typescript
public readonly primaryTagName: string;
```

- *Type:* string

The name of the second primary tag used within APM;

required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog.

---

##### `primaryTagValue`<sup>Optional</sup> <a name="primaryTagValue" id="ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition.property.primaryTagValue"></a>

```typescript
public readonly primaryTagValue: string;
```

- *Type:* string

Filter APM data by the second primary tag.

`primary_tag_name` must also be specified.

---

### FormulaAndFunctionApmResourceStatsQueryDefinition <a name="FormulaAndFunctionApmResourceStatsQueryDefinition" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionApmResourceStatsQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionApmResourceStatsQueryDefinition: FormulaAndFunctionApmResourceStatsQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for APM resource stats queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.env">env</a></code> | <code>string</code> | APM environment. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of this query to use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.service">service</a></code> | <code>string</code> | APM service name. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.stat">stat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | APM resource stat name. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.groupBy">groupBy</a></code> | <code>string[]</code> | Array of fields to group results by. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.operationName">operationName</a></code> | <code>string</code> | Name of operation on service. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.primaryTagName">primaryTagName</a></code> | <code>string</code> | Name of the second primary tag used within APM. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.primaryTagValue">primaryTagValue</a></code> | <code>string</code> | Value of the second primary tag by which to filter APM data. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.resourceName">resourceName</a></code> | <code>string</code> | APM resource name. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for APM resource stats queries.

---

##### `env`<sup>Required</sup> <a name="env" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.env"></a>

```typescript
public readonly env: string;
```

- *Type:* string

APM environment.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of this query to use in formulas.

---

##### `service`<sup>Required</sup> <a name="service" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

APM service name.

---

##### `stat`<sup>Required</sup> <a name="stat" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.stat"></a>

```typescript
public readonly stat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

APM resource stat name.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.groupBy"></a>

```typescript
public readonly groupBy: string[];
```

- *Type:* string[]

Array of fields to group results by.

---

##### `operationName`<sup>Optional</sup> <a name="operationName" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.operationName"></a>

```typescript
public readonly operationName: string;
```

- *Type:* string

Name of operation on service.

---

##### `primaryTagName`<sup>Optional</sup> <a name="primaryTagName" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.primaryTagName"></a>

```typescript
public readonly primaryTagName: string;
```

- *Type:* string

Name of the second primary tag used within APM.

Required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog

---

##### `primaryTagValue`<sup>Optional</sup> <a name="primaryTagValue" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.primaryTagValue"></a>

```typescript
public readonly primaryTagValue: string;
```

- *Type:* string

Value of the second primary tag by which to filter APM data.

`primary_tag_name` must also be specified.

---

##### `resourceName`<sup>Optional</sup> <a name="resourceName" id="ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition.property.resourceName"></a>

```typescript
public readonly resourceName: string;
```

- *Type:* string

APM resource name.

---

### FormulaAndFunctionCloudCostQueryDefinition <a name="FormulaAndFunctionCloudCostQueryDefinition" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionCloudCostQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionCloudCostQueryDefinition: FormulaAndFunctionCloudCostQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for Cloud Cost queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of the query for use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.query">query</a></code> | <code>string</code> | Query for Cloud Cost data. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregator used for the request. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for Cloud Cost queries.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of the query for use in formulas.

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Query for Cloud Cost data.

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregator used for the request.

---

### FormulaAndFunctionEventQueryDefinition <a name="FormulaAndFunctionEventQueryDefinition" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionEventQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionEventQueryDefinition: FormulaAndFunctionEventQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.compute">compute</a></code> | <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute">FormulaAndFunctionEventQueryDefinitionCompute</a></code> | Compute options. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for event platform-based queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of the query for use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.groupBy">groupBy</a></code> | <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBy">FormulaAndFunctionEventQueryGroupBy</a>[]</code> | Group by options. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.indexes">indexes</a></code> | <code>string[]</code> | An array of index names to query in the stream. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.search">search</a></code> | <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch">FormulaAndFunctionEventQueryDefinitionSearch</a></code> | Search options. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.storage">storage</a></code> | <code>string</code> | Option for storage location. |

---

##### `compute`<sup>Required</sup> <a name="compute" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.compute"></a>

```typescript
public readonly compute: FormulaAndFunctionEventQueryDefinitionCompute;
```

- *Type:* <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute">FormulaAndFunctionEventQueryDefinitionCompute</a>

Compute options.

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for event platform-based queries.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of the query for use in formulas.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.groupBy"></a>

```typescript
public readonly groupBy: FormulaAndFunctionEventQueryGroupBy[];
```

- *Type:* <a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBy">FormulaAndFunctionEventQueryGroupBy</a>[]

Group by options.

---

##### `indexes`<sup>Optional</sup> <a name="indexes" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.indexes"></a>

```typescript
public readonly indexes: string[];
```

- *Type:* string[]

An array of index names to query in the stream.

Omit or use `[]` to query all indexes at once.

---

##### `search`<sup>Optional</sup> <a name="search" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.search"></a>

```typescript
public readonly search: FormulaAndFunctionEventQueryDefinitionSearch;
```

- *Type:* <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch">FormulaAndFunctionEventQueryDefinitionSearch</a>

Search options.

---

##### `storage`<sup>Optional</sup> <a name="storage" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinition.property.storage"></a>

```typescript
public readonly storage: string;
```

- *Type:* string

Option for storage location.

Feature in Private Beta.

---

### FormulaAndFunctionEventQueryDefinitionCompute <a name="FormulaAndFunctionEventQueryDefinitionCompute" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.Initializer"></a>

```typescript
import { FormulaAndFunctionEventQueryDefinitionCompute } from 'ts-interface-generator'

const formulaAndFunctionEventQueryDefinitionCompute: FormulaAndFunctionEventQueryDefinitionCompute = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.aggregation">aggregation</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregation methods for event platform queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.interval">interval</a></code> | <code>number</code> | A time interval in milliseconds. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.metric">metric</a></code> | <code>string</code> | Measurable attribute to compute. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.aggregation"></a>

```typescript
public readonly aggregation: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregation methods for event platform queries.

---

##### `interval`<sup>Optional</sup> <a name="interval" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.interval"></a>

```typescript
public readonly interval: number;
```

- *Type:* number

A time interval in milliseconds.

---

##### `metric`<sup>Optional</sup> <a name="metric" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionCompute.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

Measurable attribute to compute.

---

### FormulaAndFunctionEventQueryDefinitionSearch <a name="FormulaAndFunctionEventQueryDefinitionSearch" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch.Initializer"></a>

```typescript
import { FormulaAndFunctionEventQueryDefinitionSearch } from 'ts-interface-generator'

const formulaAndFunctionEventQueryDefinitionSearch: FormulaAndFunctionEventQueryDefinitionSearch = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch.property.query">query</a></code> | <code>string</code> | Events search string. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.FormulaAndFunctionEventQueryDefinitionSearch.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Events search string.

---

### FormulaAndFunctionEventQueryGroupBy <a name="FormulaAndFunctionEventQueryGroupBy" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBy"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.Initializer"></a>

```typescript
import { FormulaAndFunctionEventQueryGroupBy } from 'ts-interface-generator'

const formulaAndFunctionEventQueryGroupBy: FormulaAndFunctionEventQueryGroupBy = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.facet">facet</a></code> | <code>string</code> | Event facet. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.limit">limit</a></code> | <code>number</code> | Number of groups to return. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort">FormulaAndFunctionEventQueryGroupBySort</a></code> | Options for sorting group by results. |

---

##### `facet`<sup>Required</sup> <a name="facet" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Event facet.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Number of groups to return.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBy.property.sort"></a>

```typescript
public readonly sort: FormulaAndFunctionEventQueryGroupBySort;
```

- *Type:* <a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort">FormulaAndFunctionEventQueryGroupBySort</a>

Options for sorting group by results.

---

### FormulaAndFunctionEventQueryGroupBySort <a name="FormulaAndFunctionEventQueryGroupBySort" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.Initializer"></a>

```typescript
import { FormulaAndFunctionEventQueryGroupBySort } from 'ts-interface-generator'

const formulaAndFunctionEventQueryGroupBySort: FormulaAndFunctionEventQueryGroupBySort = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.aggregation">aggregation</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregation methods for event platform queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.metric">metric</a></code> | <code>string</code> | Metric used for sorting group by results. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Direction of sort. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.aggregation"></a>

```typescript
public readonly aggregation: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregation methods for event platform queries.

---

##### `metric`<sup>Optional</sup> <a name="metric" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

Metric used for sorting group by results.

---

##### `order`<sup>Optional</sup> <a name="order" id="ts-interface-generator.FormulaAndFunctionEventQueryGroupBySort.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Direction of sort.

---

### FormulaAndFunctionMetricQueryDefinition <a name="FormulaAndFunctionMetricQueryDefinition" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionMetricQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionMetricQueryDefinition: FormulaAndFunctionMetricQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for metrics queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of the query for use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.query">query</a></code> | <code>string</code> | Metrics query definition. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | The aggregation methods available for metrics queries. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for metrics queries.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of the query for use in formulas.

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Metrics query definition.

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.FormulaAndFunctionMetricQueryDefinition.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

The aggregation methods available for metrics queries.

---

### FormulaAndFunctionProcessQueryDefinition <a name="FormulaAndFunctionProcessQueryDefinition" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionProcessQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionProcessQueryDefinition: FormulaAndFunctionProcessQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data sources that rely on the process backend. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.metric">metric</a></code> | <code>string</code> | Process metric name. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of query for use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | The aggregation methods available for metrics queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.isNormalizedCpu">isNormalizedCpu</a></code> | <code>boolean</code> | Whether to normalize the CPU percentages. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.limit">limit</a></code> | <code>number</code> | Number of hits to return. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Direction of sort. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.tagFilters">tagFilters</a></code> | <code>string[]</code> | An array of tags to filter by. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.textFilter">textFilter</a></code> | <code>string</code> | Text to use as filter. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data sources that rely on the process backend.

---

##### `metric`<sup>Required</sup> <a name="metric" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

Process metric name.

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of query for use in formulas.

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

The aggregation methods available for metrics queries.

---

##### `isNormalizedCpu`<sup>Optional</sup> <a name="isNormalizedCpu" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.isNormalizedCpu"></a>

```typescript
public readonly isNormalizedCpu: boolean;
```

- *Type:* boolean

Whether to normalize the CPU percentages.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Number of hits to return.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.sort"></a>

```typescript
public readonly sort: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Direction of sort.

---

##### `tagFilters`<sup>Optional</sup> <a name="tagFilters" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.tagFilters"></a>

```typescript
public readonly tagFilters: string[];
```

- *Type:* string[]

An array of tags to filter by.

---

##### `textFilter`<sup>Optional</sup> <a name="textFilter" id="ts-interface-generator.FormulaAndFunctionProcessQueryDefinition.property.textFilter"></a>

```typescript
public readonly textFilter: string;
```

- *Type:* string

Text to use as filter.

---

### FormulaAndFunctionSLOQueryDefinition <a name="FormulaAndFunctionSLOQueryDefinition" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.Initializer"></a>

```typescript
import { FormulaAndFunctionSLOQueryDefinition } from 'ts-interface-generator'

const formulaAndFunctionSLOQueryDefinition: FormulaAndFunctionSLOQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Data source for SLO measures queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.measure">measure</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | SLO measures queries. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.sloId">sloId</a></code> | <code>string</code> | ID of an SLO to query measures. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.additionalQueryFilters">additionalQueryFilters</a></code> | <code>string</code> | Additional filters applied to the SLO query. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.groupMode">groupMode</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Group mode to query measures. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.name">name</a></code> | <code>string</code> | Name of the query for use in formulas. |
| <code><a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.sloQueryType">sloQueryType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Name of the query for use in formulas. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Data source for SLO measures queries.

---

##### `measure`<sup>Required</sup> <a name="measure" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.measure"></a>

```typescript
public readonly measure: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

SLO measures queries.

---

##### `sloId`<sup>Required</sup> <a name="sloId" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.sloId"></a>

```typescript
public readonly sloId: string;
```

- *Type:* string

ID of an SLO to query measures.

---

##### `additionalQueryFilters`<sup>Optional</sup> <a name="additionalQueryFilters" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.additionalQueryFilters"></a>

```typescript
public readonly additionalQueryFilters: string;
```

- *Type:* string

Additional filters applied to the SLO query.

---

##### `groupMode`<sup>Optional</sup> <a name="groupMode" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.groupMode"></a>

```typescript
public readonly groupMode: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Group mode to query measures.

---

##### `name`<sup>Optional</sup> <a name="name" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of the query for use in formulas.

---

##### `sloQueryType`<sup>Optional</sup> <a name="sloQueryType" id="ts-interface-generator.FormulaAndFunctionSLOQueryDefinition.property.sloQueryType"></a>

```typescript
public readonly sloQueryType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Name of the query for use in formulas.

---

### FreeTextWidgetDefinition <a name="FreeTextWidgetDefinition" id="ts-interface-generator.FreeTextWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FreeTextWidgetDefinition.Initializer"></a>

```typescript
import { FreeTextWidgetDefinition } from 'ts-interface-generator'

const freeTextWidgetDefinition: FreeTextWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FreeTextWidgetDefinition.property.text">text</a></code> | <code>string</code> | Text to display. |
| <code><a href="#ts-interface-generator.FreeTextWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the free text widget. |
| <code><a href="#ts-interface-generator.FreeTextWidgetDefinition.property.color">color</a></code> | <code>string</code> | Color of the text. |
| <code><a href="#ts-interface-generator.FreeTextWidgetDefinition.property.fontSize">fontSize</a></code> | <code>string</code> | Size of the text. |
| <code><a href="#ts-interface-generator.FreeTextWidgetDefinition.property.textAlign">textAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |

---

##### `text`<sup>Required</sup> <a name="text" id="ts-interface-generator.FreeTextWidgetDefinition.property.text"></a>

```typescript
public readonly text: string;
```

- *Type:* string

Text to display.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.FreeTextWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the free text widget.

---

##### `color`<sup>Optional</sup> <a name="color" id="ts-interface-generator.FreeTextWidgetDefinition.property.color"></a>

```typescript
public readonly color: string;
```

- *Type:* string

Color of the text.

---

##### `fontSize`<sup>Optional</sup> <a name="fontSize" id="ts-interface-generator.FreeTextWidgetDefinition.property.fontSize"></a>

```typescript
public readonly fontSize: string;
```

- *Type:* string

Size of the text.

---

##### `textAlign`<sup>Optional</sup> <a name="textAlign" id="ts-interface-generator.FreeTextWidgetDefinition.property.textAlign"></a>

```typescript
public readonly textAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

### FunnelQuery <a name="FunnelQuery" id="ts-interface-generator.FunnelQuery"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FunnelQuery.Initializer"></a>

```typescript
import { FunnelQuery } from 'ts-interface-generator'

const funnelQuery: FunnelQuery = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FunnelQuery.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Source from which to query items to display in the funnel. |
| <code><a href="#ts-interface-generator.FunnelQuery.property.queryString">queryString</a></code> | <code>string</code> | The widget query. |
| <code><a href="#ts-interface-generator.FunnelQuery.property.steps">steps</a></code> | <code><a href="#ts-interface-generator.FunnelStep">FunnelStep</a>[]</code> | List of funnel steps. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.FunnelQuery.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Source from which to query items to display in the funnel.

---

##### `queryString`<sup>Required</sup> <a name="queryString" id="ts-interface-generator.FunnelQuery.property.queryString"></a>

```typescript
public readonly queryString: string;
```

- *Type:* string

The widget query.

---

##### `steps`<sup>Required</sup> <a name="steps" id="ts-interface-generator.FunnelQuery.property.steps"></a>

```typescript
public readonly steps: FunnelStep[];
```

- *Type:* <a href="#ts-interface-generator.FunnelStep">FunnelStep</a>[]

List of funnel steps.

---

### FunnelStep <a name="FunnelStep" id="ts-interface-generator.FunnelStep"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FunnelStep.Initializer"></a>

```typescript
import { FunnelStep } from 'ts-interface-generator'

const funnelStep: FunnelStep = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FunnelStep.property.facet">facet</a></code> | <code>string</code> | The facet of the step. |
| <code><a href="#ts-interface-generator.FunnelStep.property.value">value</a></code> | <code>string</code> | The value of the step. |

---

##### `facet`<sup>Required</sup> <a name="facet" id="ts-interface-generator.FunnelStep.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

The facet of the step.

---

##### `value`<sup>Required</sup> <a name="value" id="ts-interface-generator.FunnelStep.property.value"></a>

```typescript
public readonly value: string;
```

- *Type:* string

The value of the step.

---

### FunnelWidgetDefinition <a name="FunnelWidgetDefinition" id="ts-interface-generator.FunnelWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FunnelWidgetDefinition.Initializer"></a>

```typescript
import { FunnelWidgetDefinition } from 'ts-interface-generator'

const funnelWidgetDefinition: FunnelWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.FunnelWidgetRequest">FunnelWidgetRequest</a>[]</code> | Request payload used to query items. |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of funnel widget. |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.title">title</a></code> | <code>string</code> | The title of the widget. |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.FunnelWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | The size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.FunnelWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: FunnelWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.FunnelWidgetRequest">FunnelWidgetRequest</a>[]

Request payload used to query items.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.FunnelWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of funnel widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.FunnelWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.FunnelWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

The title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.FunnelWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.FunnelWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

The size of the title.

---

### FunnelWidgetRequest <a name="FunnelWidgetRequest" id="ts-interface-generator.FunnelWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.FunnelWidgetRequest.Initializer"></a>

```typescript
import { FunnelWidgetRequest } from 'ts-interface-generator'

const funnelWidgetRequest: FunnelWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.FunnelWidgetRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.FunnelQuery">FunnelQuery</a></code> | Updated funnel widget. |
| <code><a href="#ts-interface-generator.FunnelWidgetRequest.property.requestType">requestType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget request type. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.FunnelWidgetRequest.property.query"></a>

```typescript
public readonly query: FunnelQuery;
```

- *Type:* <a href="#ts-interface-generator.FunnelQuery">FunnelQuery</a>

Updated funnel widget.

---

##### `requestType`<sup>Required</sup> <a name="requestType" id="ts-interface-generator.FunnelWidgetRequest.property.requestType"></a>

```typescript
public readonly requestType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget request type.

---

### GeomapWidgetDefinition <a name="GeomapWidgetDefinition" id="ts-interface-generator.GeomapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.GeomapWidgetDefinition.Initializer"></a>

```typescript
import { GeomapWidgetDefinition } from 'ts-interface-generator'

const geomapWidgetDefinition: GeomapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.GeomapWidgetRequest">GeomapWidgetRequest</a>[]</code> | Array of one request object to display in the widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.style">style</a></code> | <code><a href="#ts-interface-generator.GeomapWidgetDefinitionStyle">GeomapWidgetDefinitionStyle</a></code> | The style to apply to the widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the geomap widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.view">view</a></code> | <code><a href="#ts-interface-generator.GeomapWidgetDefinitionView">GeomapWidgetDefinitionView</a></code> | The view of the world that the map should render. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | A list of custom links. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.title">title</a></code> | <code>string</code> | The title of your widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | The size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.GeomapWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: GeomapWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.GeomapWidgetRequest">GeomapWidgetRequest</a>[]

Array of one request object to display in the widget.

The request must contain a `group-by` tag whose value is a country ISO code.

See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
for information about building the `REQUEST_SCHEMA`.

---

##### `style`<sup>Required</sup> <a name="style" id="ts-interface-generator.GeomapWidgetDefinition.property.style"></a>

```typescript
public readonly style: GeomapWidgetDefinitionStyle;
```

- *Type:* <a href="#ts-interface-generator.GeomapWidgetDefinitionStyle">GeomapWidgetDefinitionStyle</a>

The style to apply to the widget.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.GeomapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the geomap widget.

---

##### `view`<sup>Required</sup> <a name="view" id="ts-interface-generator.GeomapWidgetDefinition.property.view"></a>

```typescript
public readonly view: GeomapWidgetDefinitionView;
```

- *Type:* <a href="#ts-interface-generator.GeomapWidgetDefinitionView">GeomapWidgetDefinitionView</a>

The view of the world that the map should render.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.GeomapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

A list of custom links.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.GeomapWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.GeomapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

The title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.GeomapWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.GeomapWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

The size of the title.

---

### GeomapWidgetDefinitionStyle <a name="GeomapWidgetDefinitionStyle" id="ts-interface-generator.GeomapWidgetDefinitionStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.GeomapWidgetDefinitionStyle.Initializer"></a>

```typescript
import { GeomapWidgetDefinitionStyle } from 'ts-interface-generator'

const geomapWidgetDefinitionStyle: GeomapWidgetDefinitionStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinitionStyle.property.palette">palette</a></code> | <code>string</code> | The color palette to apply to the widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinitionStyle.property.paletteFlip">paletteFlip</a></code> | <code>boolean</code> | Whether to flip the palette tones. |

---

##### `palette`<sup>Required</sup> <a name="palette" id="ts-interface-generator.GeomapWidgetDefinitionStyle.property.palette"></a>

```typescript
public readonly palette: string;
```

- *Type:* string

The color palette to apply to the widget.

---

##### `paletteFlip`<sup>Required</sup> <a name="paletteFlip" id="ts-interface-generator.GeomapWidgetDefinitionStyle.property.paletteFlip"></a>

```typescript
public readonly paletteFlip: boolean;
```

- *Type:* boolean

Whether to flip the palette tones.

---

### GeomapWidgetDefinitionView <a name="GeomapWidgetDefinitionView" id="ts-interface-generator.GeomapWidgetDefinitionView"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.GeomapWidgetDefinitionView.Initializer"></a>

```typescript
import { GeomapWidgetDefinitionView } from 'ts-interface-generator'

const geomapWidgetDefinitionView: GeomapWidgetDefinitionView = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.GeomapWidgetDefinitionView.property.focus">focus</a></code> | <code>string</code> | The 2-letter ISO code of a country to focus the map on. |

---

##### `focus`<sup>Required</sup> <a name="focus" id="ts-interface-generator.GeomapWidgetDefinitionView.property.focus"></a>

```typescript
public readonly focus: string;
```

- *Type:* string

The 2-letter ISO code of a country to focus the map on.

Or `WORLD`.

---

### GeomapWidgetRequest <a name="GeomapWidgetRequest" id="ts-interface-generator.GeomapWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.GeomapWidgetRequest.Initializer"></a>

```typescript
import { GeomapWidgetRequest } from 'ts-interface-generator'

const geomapWidgetRequest: GeomapWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.columns">columns</a></code> | <code><a href="#ts-interface-generator.ListStreamColumn">ListStreamColumn</a>[]</code> | Widget columns. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.q">q</a></code> | <code>string</code> | The widget metrics query. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.ListStreamQuery">ListStreamQuery</a></code> | Updated list stream widget. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.GeomapWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |

---

##### `columns`<sup>Optional</sup> <a name="columns" id="ts-interface-generator.GeomapWidgetRequest.property.columns"></a>

```typescript
public readonly columns: ListStreamColumn[];
```

- *Type:* <a href="#ts-interface-generator.ListStreamColumn">ListStreamColumn</a>[]

Widget columns.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.GeomapWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.GeomapWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.GeomapWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

The widget metrics query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.GeomapWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `query`<sup>Optional</sup> <a name="query" id="ts-interface-generator.GeomapWidgetRequest.property.query"></a>

```typescript
public readonly query: ListStreamQuery;
```

- *Type:* <a href="#ts-interface-generator.ListStreamQuery">ListStreamQuery</a>

Updated list stream widget.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.GeomapWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.GeomapWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.GeomapWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

### GroupWidgetDefinition <a name="GroupWidgetDefinition" id="ts-interface-generator.GroupWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.GroupWidgetDefinition.Initializer"></a>

```typescript
import { GroupWidgetDefinition } from 'ts-interface-generator'

const groupWidgetDefinition: GroupWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.layoutType">layoutType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Layout type of the group. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the group widget. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.widgets">widgets</a></code> | <code><a href="#ts-interface-generator.Widget">Widget</a>[]</code> | List of widget groups. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.backgroundColor">backgroundColor</a></code> | <code>string</code> | Background color of the group title. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.bannerImg">bannerImg</a></code> | <code>string</code> | URL of image to display as a banner for the group. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.showTitle">showTitle</a></code> | <code>boolean</code> | Whether to show the title or not. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.GroupWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |

---

##### `layoutType`<sup>Required</sup> <a name="layoutType" id="ts-interface-generator.GroupWidgetDefinition.property.layoutType"></a>

```typescript
public readonly layoutType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Layout type of the group.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.GroupWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the group widget.

---

##### `widgets`<sup>Required</sup> <a name="widgets" id="ts-interface-generator.GroupWidgetDefinition.property.widgets"></a>

```typescript
public readonly widgets: Widget[];
```

- *Type:* <a href="#ts-interface-generator.Widget">Widget</a>[]

List of widget groups.

---

##### `backgroundColor`<sup>Optional</sup> <a name="backgroundColor" id="ts-interface-generator.GroupWidgetDefinition.property.backgroundColor"></a>

```typescript
public readonly backgroundColor: string;
```

- *Type:* string

Background color of the group title.

---

##### `bannerImg`<sup>Optional</sup> <a name="bannerImg" id="ts-interface-generator.GroupWidgetDefinition.property.bannerImg"></a>

```typescript
public readonly bannerImg: string;
```

- *Type:* string

URL of image to display as a banner for the group.

---

##### `showTitle`<sup>Optional</sup> <a name="showTitle" id="ts-interface-generator.GroupWidgetDefinition.property.showTitle"></a>

```typescript
public readonly showTitle: boolean;
```

- *Type:* boolean

Whether to show the title or not.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.GroupWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.GroupWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

### HeatMapWidgetDefinition <a name="HeatMapWidgetDefinition" id="ts-interface-generator.HeatMapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HeatMapWidgetDefinition.Initializer"></a>

```typescript
import { HeatMapWidgetDefinition } from 'ts-interface-generator'

const heatMapWidgetDefinition: HeatMapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.HeatMapWidgetRequest">HeatMapWidgetRequest</a>[]</code> | List of widget types. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the heat map widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.events">events</a></code> | <code><a href="#ts-interface-generator.WidgetEvent">WidgetEvent</a>[]</code> | List of widget events. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.legendSize">legendSize</a></code> | <code>string</code> | Available legend sizes for a widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.showLegend">showLegend</a></code> | <code>boolean</code> | Whether or not to display the legend on this widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |
| <code><a href="#ts-interface-generator.HeatMapWidgetDefinition.property.yaxis">yaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.HeatMapWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: HeatMapWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.HeatMapWidgetRequest">HeatMapWidgetRequest</a>[]

List of widget types.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.HeatMapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the heat map widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.HeatMapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `events`<sup>Optional</sup> <a name="events" id="ts-interface-generator.HeatMapWidgetDefinition.property.events"></a>

```typescript
public readonly events: WidgetEvent[];
```

- *Type:* <a href="#ts-interface-generator.WidgetEvent">WidgetEvent</a>[]

List of widget events.

---

##### `legendSize`<sup>Optional</sup> <a name="legendSize" id="ts-interface-generator.HeatMapWidgetDefinition.property.legendSize"></a>

```typescript
public readonly legendSize: string;
```

- *Type:* string

Available legend sizes for a widget.

Should be one of "0", "2", "4", "8", "16", or "auto".

---

##### `showLegend`<sup>Optional</sup> <a name="showLegend" id="ts-interface-generator.HeatMapWidgetDefinition.property.showLegend"></a>

```typescript
public readonly showLegend: boolean;
```

- *Type:* boolean

Whether or not to display the legend on this widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.HeatMapWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.HeatMapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.HeatMapWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.HeatMapWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

##### `yaxis`<sup>Optional</sup> <a name="yaxis" id="ts-interface-generator.HeatMapWidgetDefinition.property.yaxis"></a>

```typescript
public readonly yaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

### HeatMapWidgetRequest <a name="HeatMapWidgetRequest" id="ts-interface-generator.HeatMapWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HeatMapWidgetRequest.Initializer"></a>

```typescript
import { HeatMapWidgetRequest } from 'ts-interface-generator'

const heatMapWidgetRequest: HeatMapWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.EventQueryDefinition">EventQueryDefinition</a></code> | The event query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.q">q</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HeatMapWidgetRequest.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a></code> | Widget style definition. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: EventQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.EventQueryDefinition">EventQueryDefinition</a>

The event query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.HeatMapWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.HeatMapWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Widget query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.HeatMapWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.HeatMapWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.HeatMapWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.HeatMapWidgetRequest.property.style"></a>

```typescript
public readonly style: WidgetStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a>

Widget style definition.

---

### HostMapRequest <a name="HostMapRequest" id="ts-interface-generator.HostMapRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HostMapRequest.Initializer"></a>

```typescript
import { HostMapRequest } from 'ts-interface-generator'

const hostMapRequest: HostMapRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HostMapRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.q">q</a></code> | <code>string</code> | Query definition. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.HostMapRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.HostMapRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.HostMapRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.HostMapRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.HostMapRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.HostMapRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.HostMapRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.HostMapRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Query definition.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.HostMapRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.HostMapRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

### HostMapWidgetDefinition <a name="HostMapWidgetDefinition" id="ts-interface-generator.HostMapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HostMapWidgetDefinition.Initializer"></a>

```typescript
import { HostMapWidgetDefinition } from 'ts-interface-generator'

const hostMapWidgetDefinition: HostMapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.HostMapWidgetDefinitionRequests">HostMapWidgetDefinitionRequests</a></code> | List of definitions. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the host map widget. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.group">group</a></code> | <code>string[]</code> | List of tag prefixes to group by. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.nodeType">nodeType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Which type of node to use in the map. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.noGroupHosts">noGroupHosts</a></code> | <code>boolean</code> | Whether to show the hosts that don’t fit in a group. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.noMetricHosts">noMetricHosts</a></code> | <code>boolean</code> | Whether to show the hosts with no metrics. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.notes">notes</a></code> | <code>string</code> | Notes on the title. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.scope">scope</a></code> | <code>string[]</code> | List of tags used to filter the map. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.style">style</a></code> | <code><a href="#ts-interface-generator.HostMapWidgetDefinitionStyle">HostMapWidgetDefinitionStyle</a></code> | The style to apply to the widget. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.HostMapWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: HostMapWidgetDefinitionRequests;
```

- *Type:* <a href="#ts-interface-generator.HostMapWidgetDefinitionRequests">HostMapWidgetDefinitionRequests</a>

List of definitions.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.HostMapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the host map widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.HostMapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `group`<sup>Optional</sup> <a name="group" id="ts-interface-generator.HostMapWidgetDefinition.property.group"></a>

```typescript
public readonly group: string[];
```

- *Type:* string[]

List of tag prefixes to group by.

---

##### `nodeType`<sup>Optional</sup> <a name="nodeType" id="ts-interface-generator.HostMapWidgetDefinition.property.nodeType"></a>

```typescript
public readonly nodeType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Which type of node to use in the map.

---

##### `noGroupHosts`<sup>Optional</sup> <a name="noGroupHosts" id="ts-interface-generator.HostMapWidgetDefinition.property.noGroupHosts"></a>

```typescript
public readonly noGroupHosts: boolean;
```

- *Type:* boolean

Whether to show the hosts that don’t fit in a group.

---

##### `noMetricHosts`<sup>Optional</sup> <a name="noMetricHosts" id="ts-interface-generator.HostMapWidgetDefinition.property.noMetricHosts"></a>

```typescript
public readonly noMetricHosts: boolean;
```

- *Type:* boolean

Whether to show the hosts with no metrics.

---

##### `notes`<sup>Optional</sup> <a name="notes" id="ts-interface-generator.HostMapWidgetDefinition.property.notes"></a>

```typescript
public readonly notes: string;
```

- *Type:* string

Notes on the title.

---

##### `scope`<sup>Optional</sup> <a name="scope" id="ts-interface-generator.HostMapWidgetDefinition.property.scope"></a>

```typescript
public readonly scope: string[];
```

- *Type:* string[]

List of tags used to filter the map.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.HostMapWidgetDefinition.property.style"></a>

```typescript
public readonly style: HostMapWidgetDefinitionStyle;
```

- *Type:* <a href="#ts-interface-generator.HostMapWidgetDefinitionStyle">HostMapWidgetDefinitionStyle</a>

The style to apply to the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.HostMapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.HostMapWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.HostMapWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### HostMapWidgetDefinitionRequests <a name="HostMapWidgetDefinitionRequests" id="ts-interface-generator.HostMapWidgetDefinitionRequests"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HostMapWidgetDefinitionRequests.Initializer"></a>

```typescript
import { HostMapWidgetDefinitionRequests } from 'ts-interface-generator'

const hostMapWidgetDefinitionRequests: HostMapWidgetDefinitionRequests = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionRequests.property.fill">fill</a></code> | <code><a href="#ts-interface-generator.HostMapRequest">HostMapRequest</a></code> | Updated host map. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionRequests.property.size">size</a></code> | <code><a href="#ts-interface-generator.HostMapRequest">HostMapRequest</a></code> | Updated host map. |

---

##### `fill`<sup>Optional</sup> <a name="fill" id="ts-interface-generator.HostMapWidgetDefinitionRequests.property.fill"></a>

```typescript
public readonly fill: HostMapRequest;
```

- *Type:* <a href="#ts-interface-generator.HostMapRequest">HostMapRequest</a>

Updated host map.

---

##### `size`<sup>Optional</sup> <a name="size" id="ts-interface-generator.HostMapWidgetDefinitionRequests.property.size"></a>

```typescript
public readonly size: HostMapRequest;
```

- *Type:* <a href="#ts-interface-generator.HostMapRequest">HostMapRequest</a>

Updated host map.

---

### HostMapWidgetDefinitionStyle <a name="HostMapWidgetDefinitionStyle" id="ts-interface-generator.HostMapWidgetDefinitionStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.HostMapWidgetDefinitionStyle.Initializer"></a>

```typescript
import { HostMapWidgetDefinitionStyle } from 'ts-interface-generator'

const hostMapWidgetDefinitionStyle: HostMapWidgetDefinitionStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionStyle.property.fillMax">fillMax</a></code> | <code>string</code> | Max value to use to color the map. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionStyle.property.fillMin">fillMin</a></code> | <code>string</code> | Min value to use to color the map. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionStyle.property.palette">palette</a></code> | <code>string</code> | Color palette to apply to the widget. |
| <code><a href="#ts-interface-generator.HostMapWidgetDefinitionStyle.property.paletteFlip">paletteFlip</a></code> | <code>boolean</code> | Whether to flip the palette tones. |

---

##### `fillMax`<sup>Optional</sup> <a name="fillMax" id="ts-interface-generator.HostMapWidgetDefinitionStyle.property.fillMax"></a>

```typescript
public readonly fillMax: string;
```

- *Type:* string

Max value to use to color the map.

---

##### `fillMin`<sup>Optional</sup> <a name="fillMin" id="ts-interface-generator.HostMapWidgetDefinitionStyle.property.fillMin"></a>

```typescript
public readonly fillMin: string;
```

- *Type:* string

Min value to use to color the map.

---

##### `palette`<sup>Optional</sup> <a name="palette" id="ts-interface-generator.HostMapWidgetDefinitionStyle.property.palette"></a>

```typescript
public readonly palette: string;
```

- *Type:* string

Color palette to apply to the widget.

---

##### `paletteFlip`<sup>Optional</sup> <a name="paletteFlip" id="ts-interface-generator.HostMapWidgetDefinitionStyle.property.paletteFlip"></a>

```typescript
public readonly paletteFlip: boolean;
```

- *Type:* boolean

Whether to flip the palette tones.

---

### ImageWidgetDefinition <a name="ImageWidgetDefinition" id="ts-interface-generator.ImageWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ImageWidgetDefinition.Initializer"></a>

```typescript
import { ImageWidgetDefinition } from 'ts-interface-generator'

const imageWidgetDefinition: ImageWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the image widget. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.url">url</a></code> | <code>string</code> | URL of the image. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.hasBackground">hasBackground</a></code> | <code>boolean</code> | Whether to display a background or not. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.hasBorder">hasBorder</a></code> | <code>boolean</code> | Whether to display a border or not. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.horizontalAlign">horizontalAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Horizontal alignment. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.margin">margin</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Size of the margins around the image. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.sizing">sizing</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to size the image on the widget. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.urlDarkTheme">urlDarkTheme</a></code> | <code>string</code> | URL of the image in dark mode. |
| <code><a href="#ts-interface-generator.ImageWidgetDefinition.property.verticalAlign">verticalAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Vertical alignment. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ImageWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the image widget.

---

##### `url`<sup>Required</sup> <a name="url" id="ts-interface-generator.ImageWidgetDefinition.property.url"></a>

```typescript
public readonly url: string;
```

- *Type:* string

URL of the image.

---

##### `hasBackground`<sup>Optional</sup> <a name="hasBackground" id="ts-interface-generator.ImageWidgetDefinition.property.hasBackground"></a>

```typescript
public readonly hasBackground: boolean;
```

- *Type:* boolean

Whether to display a background or not.

---

##### `hasBorder`<sup>Optional</sup> <a name="hasBorder" id="ts-interface-generator.ImageWidgetDefinition.property.hasBorder"></a>

```typescript
public readonly hasBorder: boolean;
```

- *Type:* boolean

Whether to display a border or not.

---

##### `horizontalAlign`<sup>Optional</sup> <a name="horizontalAlign" id="ts-interface-generator.ImageWidgetDefinition.property.horizontalAlign"></a>

```typescript
public readonly horizontalAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Horizontal alignment.

---

##### `margin`<sup>Optional</sup> <a name="margin" id="ts-interface-generator.ImageWidgetDefinition.property.margin"></a>

```typescript
public readonly margin: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Size of the margins around the image.

**Note**: `small` and `large` values are deprecated.

---

##### `sizing`<sup>Optional</sup> <a name="sizing" id="ts-interface-generator.ImageWidgetDefinition.property.sizing"></a>

```typescript
public readonly sizing: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to size the image on the widget.

The values are based on the image `object-fit` CSS properties.
**Note**: `zoom`, `fit` and `center` values are deprecated.

---

##### `urlDarkTheme`<sup>Optional</sup> <a name="urlDarkTheme" id="ts-interface-generator.ImageWidgetDefinition.property.urlDarkTheme"></a>

```typescript
public readonly urlDarkTheme: string;
```

- *Type:* string

URL of the image in dark mode.

---

##### `verticalAlign`<sup>Optional</sup> <a name="verticalAlign" id="ts-interface-generator.ImageWidgetDefinition.property.verticalAlign"></a>

```typescript
public readonly verticalAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Vertical alignment.

---

### ListStreamColumn <a name="ListStreamColumn" id="ts-interface-generator.ListStreamColumn"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamColumn.Initializer"></a>

```typescript
import { ListStreamColumn } from 'ts-interface-generator'

const listStreamColumn: ListStreamColumn = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamColumn.property.field">field</a></code> | <code>string</code> | Widget column field. |
| <code><a href="#ts-interface-generator.ListStreamColumn.property.width">width</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget column width. |

---

##### `field`<sup>Required</sup> <a name="field" id="ts-interface-generator.ListStreamColumn.property.field"></a>

```typescript
public readonly field: string;
```

- *Type:* string

Widget column field.

---

##### `width`<sup>Required</sup> <a name="width" id="ts-interface-generator.ListStreamColumn.property.width"></a>

```typescript
public readonly width: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget column width.

---

### ListStreamComputeItems <a name="ListStreamComputeItems" id="ts-interface-generator.ListStreamComputeItems"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamComputeItems.Initializer"></a>

```typescript
import { ListStreamComputeItems } from 'ts-interface-generator'

const listStreamComputeItems: ListStreamComputeItems = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamComputeItems.property.aggregation">aggregation</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregation value. |
| <code><a href="#ts-interface-generator.ListStreamComputeItems.property.facet">facet</a></code> | <code>string</code> | Facet name. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.ListStreamComputeItems.property.aggregation"></a>

```typescript
public readonly aggregation: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregation value.

---

##### `facet`<sup>Optional</sup> <a name="facet" id="ts-interface-generator.ListStreamComputeItems.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Facet name.

---

### ListStreamGroupByItems <a name="ListStreamGroupByItems" id="ts-interface-generator.ListStreamGroupByItems"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamGroupByItems.Initializer"></a>

```typescript
import { ListStreamGroupByItems } from 'ts-interface-generator'

const listStreamGroupByItems: ListStreamGroupByItems = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamGroupByItems.property.facet">facet</a></code> | <code>string</code> | Facet name. |

---

##### `facet`<sup>Required</sup> <a name="facet" id="ts-interface-generator.ListStreamGroupByItems.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Facet name.

---

### ListStreamQuery <a name="ListStreamQuery" id="ts-interface-generator.ListStreamQuery"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamQuery.Initializer"></a>

```typescript
import { ListStreamQuery } from 'ts-interface-generator'

const listStreamQuery: ListStreamQuery = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Source from which to query items to display in the stream. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.queryString">queryString</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.compute">compute</a></code> | <code><a href="#ts-interface-generator.ListStreamComputeItems">ListStreamComputeItems</a>[]</code> | Compute configuration for the List Stream Widget. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.eventSize">eventSize</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Size to use to display an event. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.groupBy">groupBy</a></code> | <code><a href="#ts-interface-generator.ListStreamGroupByItems">ListStreamGroupByItems</a>[]</code> | Group by configuration for the List Stream Widget. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.indexes">indexes</a></code> | <code>string[]</code> | List of indexes. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a></code> | Which column and order to sort by. |
| <code><a href="#ts-interface-generator.ListStreamQuery.property.storage">storage</a></code> | <code>string</code> | Option for storage location. |

---

##### `dataSource`<sup>Required</sup> <a name="dataSource" id="ts-interface-generator.ListStreamQuery.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Source from which to query items to display in the stream.

---

##### `queryString`<sup>Required</sup> <a name="queryString" id="ts-interface-generator.ListStreamQuery.property.queryString"></a>

```typescript
public readonly queryString: string;
```

- *Type:* string

Widget query.

---

##### `compute`<sup>Optional</sup> <a name="compute" id="ts-interface-generator.ListStreamQuery.property.compute"></a>

```typescript
public readonly compute: ListStreamComputeItems[];
```

- *Type:* <a href="#ts-interface-generator.ListStreamComputeItems">ListStreamComputeItems</a>[]

Compute configuration for the List Stream Widget.

Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.

---

##### `eventSize`<sup>Optional</sup> <a name="eventSize" id="ts-interface-generator.ListStreamQuery.property.eventSize"></a>

```typescript
public readonly eventSize: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Size to use to display an event.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.ListStreamQuery.property.groupBy"></a>

```typescript
public readonly groupBy: ListStreamGroupByItems[];
```

- *Type:* <a href="#ts-interface-generator.ListStreamGroupByItems">ListStreamGroupByItems</a>[]

Group by configuration for the List Stream Widget.

Group by can be used only with logs_pattern_stream (up to 3 items) or logs_transaction_stream (one group by item is required) list stream source.

---

##### `indexes`<sup>Optional</sup> <a name="indexes" id="ts-interface-generator.ListStreamQuery.property.indexes"></a>

```typescript
public readonly indexes: string[];
```

- *Type:* string[]

List of indexes.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.ListStreamQuery.property.sort"></a>

```typescript
public readonly sort: WidgetFieldSort;
```

- *Type:* <a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a>

Which column and order to sort by.

---

##### `storage`<sup>Optional</sup> <a name="storage" id="ts-interface-generator.ListStreamQuery.property.storage"></a>

```typescript
public readonly storage: string;
```

- *Type:* string

Option for storage location.

Feature in Private Beta.

---

### ListStreamWidgetDefinition <a name="ListStreamWidgetDefinition" id="ts-interface-generator.ListStreamWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamWidgetDefinition.Initializer"></a>

```typescript
import { ListStreamWidgetDefinition } from 'ts-interface-generator'

const listStreamWidgetDefinition: ListStreamWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.ListStreamWidgetRequest">ListStreamWidgetRequest</a>[]</code> | Request payload used to query items. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the list stream widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.legendSize">legendSize</a></code> | <code>string</code> | Available legend sizes for a widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.showLegend">showLegend</a></code> | <code>boolean</code> | Whether or not to display the legend on this widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.ListStreamWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: ListStreamWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.ListStreamWidgetRequest">ListStreamWidgetRequest</a>[]

Request payload used to query items.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ListStreamWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the list stream widget.

---

##### `legendSize`<sup>Optional</sup> <a name="legendSize" id="ts-interface-generator.ListStreamWidgetDefinition.property.legendSize"></a>

```typescript
public readonly legendSize: string;
```

- *Type:* string

Available legend sizes for a widget.

Should be one of "0", "2", "4", "8", "16", or "auto".

---

##### `showLegend`<sup>Optional</sup> <a name="showLegend" id="ts-interface-generator.ListStreamWidgetDefinition.property.showLegend"></a>

```typescript
public readonly showLegend: boolean;
```

- *Type:* boolean

Whether or not to display the legend on this widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.ListStreamWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ListStreamWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ListStreamWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ListStreamWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### ListStreamWidgetRequest <a name="ListStreamWidgetRequest" id="ts-interface-generator.ListStreamWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ListStreamWidgetRequest.Initializer"></a>

```typescript
import { ListStreamWidgetRequest } from 'ts-interface-generator'

const listStreamWidgetRequest: ListStreamWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ListStreamWidgetRequest.property.columns">columns</a></code> | <code><a href="#ts-interface-generator.ListStreamColumn">ListStreamColumn</a>[]</code> | Widget columns. |
| <code><a href="#ts-interface-generator.ListStreamWidgetRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.ListStreamQuery">ListStreamQuery</a></code> | Updated list stream widget. |
| <code><a href="#ts-interface-generator.ListStreamWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget response format. |

---

##### `columns`<sup>Required</sup> <a name="columns" id="ts-interface-generator.ListStreamWidgetRequest.property.columns"></a>

```typescript
public readonly columns: ListStreamColumn[];
```

- *Type:* <a href="#ts-interface-generator.ListStreamColumn">ListStreamColumn</a>[]

Widget columns.

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.ListStreamWidgetRequest.property.query"></a>

```typescript
public readonly query: ListStreamQuery;
```

- *Type:* <a href="#ts-interface-generator.ListStreamQuery">ListStreamQuery</a>

Updated list stream widget.

---

##### `responseFormat`<sup>Required</sup> <a name="responseFormat" id="ts-interface-generator.ListStreamWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget response format.

---

### LogQueryDefinition <a name="LogQueryDefinition" id="ts-interface-generator.LogQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogQueryDefinition.Initializer"></a>

```typescript
import { LogQueryDefinition } from 'ts-interface-generator'

const logQueryDefinition: LogQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogQueryDefinition.property.compute">compute</a></code> | <code><a href="#ts-interface-generator.LogsQueryCompute">LogsQueryCompute</a></code> | Define computation for a log query. |
| <code><a href="#ts-interface-generator.LogQueryDefinition.property.groupBy">groupBy</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBy">LogQueryDefinitionGroupBy</a>[]</code> | List of tag prefixes to group by in the case of a cluster check. |
| <code><a href="#ts-interface-generator.LogQueryDefinition.property.index">index</a></code> | <code>string</code> | A coma separated-list of index names. |
| <code><a href="#ts-interface-generator.LogQueryDefinition.property.multiCompute">multiCompute</a></code> | <code><a href="#ts-interface-generator.LogsQueryCompute">LogsQueryCompute</a>[]</code> | This field is mutually exclusive with `compute`. |
| <code><a href="#ts-interface-generator.LogQueryDefinition.property.search">search</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinitionSearch">LogQueryDefinitionSearch</a></code> | The query being made on the logs. |

---

##### `compute`<sup>Optional</sup> <a name="compute" id="ts-interface-generator.LogQueryDefinition.property.compute"></a>

```typescript
public readonly compute: LogsQueryCompute;
```

- *Type:* <a href="#ts-interface-generator.LogsQueryCompute">LogsQueryCompute</a>

Define computation for a log query.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.LogQueryDefinition.property.groupBy"></a>

```typescript
public readonly groupBy: LogQueryDefinitionGroupBy[];
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinitionGroupBy">LogQueryDefinitionGroupBy</a>[]

List of tag prefixes to group by in the case of a cluster check.

---

##### `index`<sup>Optional</sup> <a name="index" id="ts-interface-generator.LogQueryDefinition.property.index"></a>

```typescript
public readonly index: string;
```

- *Type:* string

A coma separated-list of index names.

Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)

---

##### `multiCompute`<sup>Optional</sup> <a name="multiCompute" id="ts-interface-generator.LogQueryDefinition.property.multiCompute"></a>

```typescript
public readonly multiCompute: LogsQueryCompute[];
```

- *Type:* <a href="#ts-interface-generator.LogsQueryCompute">LogsQueryCompute</a>[]

This field is mutually exclusive with `compute`.

---

##### `search`<sup>Optional</sup> <a name="search" id="ts-interface-generator.LogQueryDefinition.property.search"></a>

```typescript
public readonly search: LogQueryDefinitionSearch;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinitionSearch">LogQueryDefinitionSearch</a>

The query being made on the logs.

---

### LogQueryDefinitionGroupBy <a name="LogQueryDefinitionGroupBy" id="ts-interface-generator.LogQueryDefinitionGroupBy"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogQueryDefinitionGroupBy.Initializer"></a>

```typescript
import { LogQueryDefinitionGroupBy } from 'ts-interface-generator'

const logQueryDefinitionGroupBy: LogQueryDefinitionGroupBy = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBy.property.facet">facet</a></code> | <code>string</code> | Facet name. |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBy.property.limit">limit</a></code> | <code>number</code> | Maximum number of items in the group. |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBy.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBySort">LogQueryDefinitionGroupBySort</a></code> | Define a sorting method. |

---

##### `facet`<sup>Required</sup> <a name="facet" id="ts-interface-generator.LogQueryDefinitionGroupBy.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Facet name.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.LogQueryDefinitionGroupBy.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Maximum number of items in the group.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.LogQueryDefinitionGroupBy.property.sort"></a>

```typescript
public readonly sort: LogQueryDefinitionGroupBySort;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinitionGroupBySort">LogQueryDefinitionGroupBySort</a>

Define a sorting method.

---

### LogQueryDefinitionGroupBySort <a name="LogQueryDefinitionGroupBySort" id="ts-interface-generator.LogQueryDefinitionGroupBySort"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogQueryDefinitionGroupBySort.Initializer"></a>

```typescript
import { LogQueryDefinitionGroupBySort } from 'ts-interface-generator'

const logQueryDefinitionGroupBySort: LogQueryDefinitionGroupBySort = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBySort.property.aggregation">aggregation</a></code> | <code>string</code> | The aggregation method. |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBySort.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |
| <code><a href="#ts-interface-generator.LogQueryDefinitionGroupBySort.property.facet">facet</a></code> | <code>string</code> | Facet name. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.LogQueryDefinitionGroupBySort.property.aggregation"></a>

```typescript
public readonly aggregation: string;
```

- *Type:* string

The aggregation method.

---

##### `order`<sup>Required</sup> <a name="order" id="ts-interface-generator.LogQueryDefinitionGroupBySort.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

##### `facet`<sup>Optional</sup> <a name="facet" id="ts-interface-generator.LogQueryDefinitionGroupBySort.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Facet name.

---

### LogQueryDefinitionSearch <a name="LogQueryDefinitionSearch" id="ts-interface-generator.LogQueryDefinitionSearch"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogQueryDefinitionSearch.Initializer"></a>

```typescript
import { LogQueryDefinitionSearch } from 'ts-interface-generator'

const logQueryDefinitionSearch: LogQueryDefinitionSearch = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogQueryDefinitionSearch.property.query">query</a></code> | <code>string</code> | Search value to apply. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.LogQueryDefinitionSearch.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Search value to apply.

---

### LogsQueryCompute <a name="LogsQueryCompute" id="ts-interface-generator.LogsQueryCompute"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogsQueryCompute.Initializer"></a>

```typescript
import { LogsQueryCompute } from 'ts-interface-generator'

const logsQueryCompute: LogsQueryCompute = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogsQueryCompute.property.aggregation">aggregation</a></code> | <code>string</code> | The aggregation method. |
| <code><a href="#ts-interface-generator.LogsQueryCompute.property.facet">facet</a></code> | <code>string</code> | Facet name. |
| <code><a href="#ts-interface-generator.LogsQueryCompute.property.interval">interval</a></code> | <code>number</code> | Define a time interval in seconds. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.LogsQueryCompute.property.aggregation"></a>

```typescript
public readonly aggregation: string;
```

- *Type:* string

The aggregation method.

---

##### `facet`<sup>Optional</sup> <a name="facet" id="ts-interface-generator.LogsQueryCompute.property.facet"></a>

```typescript
public readonly facet: string;
```

- *Type:* string

Facet name.

---

##### `interval`<sup>Optional</sup> <a name="interval" id="ts-interface-generator.LogsQueryCompute.property.interval"></a>

```typescript
public readonly interval: number;
```

- *Type:* number

Define a time interval in seconds.

---

### LogStreamWidgetDefinition <a name="LogStreamWidgetDefinition" id="ts-interface-generator.LogStreamWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.LogStreamWidgetDefinition.Initializer"></a>

```typescript
import { LogStreamWidgetDefinition } from 'ts-interface-generator'

const logStreamWidgetDefinition: LogStreamWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the log stream widget. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.columns">columns</a></code> | <code>string[]</code> | Which columns to display on the widget. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.indexes">indexes</a></code> | <code>string[]</code> | An array of index names to query in the stream. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.logset">logset</a></code> | <code>string</code> | ID of the log set to use. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.messageDisplay">messageDisplay</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Amount of log lines to display. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.query">query</a></code> | <code>string</code> | Query to filter the log stream with. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.showDateColumn">showDateColumn</a></code> | <code>boolean</code> | Whether to show the date column or not. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.showMessageColumn">showMessageColumn</a></code> | <code>boolean</code> | Whether to show the message column or not. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a></code> | Which column and order to sort by. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.LogStreamWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.LogStreamWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the log stream widget.

---

##### `columns`<sup>Optional</sup> <a name="columns" id="ts-interface-generator.LogStreamWidgetDefinition.property.columns"></a>

```typescript
public readonly columns: string[];
```

- *Type:* string[]

Which columns to display on the widget.

---

##### `indexes`<sup>Optional</sup> <a name="indexes" id="ts-interface-generator.LogStreamWidgetDefinition.property.indexes"></a>

```typescript
public readonly indexes: string[];
```

- *Type:* string[]

An array of index names to query in the stream.

Use [] to query all indexes at once.

---

##### `logset`<sup>Optional</sup> <a name="logset" id="ts-interface-generator.LogStreamWidgetDefinition.property.logset"></a>

```typescript
public readonly logset: string;
```

- *Type:* string

ID of the log set to use.

---

##### `messageDisplay`<sup>Optional</sup> <a name="messageDisplay" id="ts-interface-generator.LogStreamWidgetDefinition.property.messageDisplay"></a>

```typescript
public readonly messageDisplay: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Amount of log lines to display.

---

##### `query`<sup>Optional</sup> <a name="query" id="ts-interface-generator.LogStreamWidgetDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Query to filter the log stream with.

---

##### `showDateColumn`<sup>Optional</sup> <a name="showDateColumn" id="ts-interface-generator.LogStreamWidgetDefinition.property.showDateColumn"></a>

```typescript
public readonly showDateColumn: boolean;
```

- *Type:* boolean

Whether to show the date column or not.

---

##### `showMessageColumn`<sup>Optional</sup> <a name="showMessageColumn" id="ts-interface-generator.LogStreamWidgetDefinition.property.showMessageColumn"></a>

```typescript
public readonly showMessageColumn: boolean;
```

- *Type:* boolean

Whether to show the message column or not.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.LogStreamWidgetDefinition.property.sort"></a>

```typescript
public readonly sort: WidgetFieldSort;
```

- *Type:* <a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a>

Which column and order to sort by.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.LogStreamWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.LogStreamWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.LogStreamWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.LogStreamWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### MonitorSummaryWidgetDefinition <a name="MonitorSummaryWidgetDefinition" id="ts-interface-generator.MonitorSummaryWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.MonitorSummaryWidgetDefinition.Initializer"></a>

```typescript
import { MonitorSummaryWidgetDefinition } from 'ts-interface-generator'

const monitorSummaryWidgetDefinition: MonitorSummaryWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.query">query</a></code> | <code>string</code> | Query to filter the monitors with. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the monitor summary widget. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.colorPreference">colorPreference</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Which color to use on the widget. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.count">count</a></code> | <code>number</code> | The number of monitors to display. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.displayFormat">displayFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | What to display on the widget. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.hideZeroCounts">hideZeroCounts</a></code> | <code>boolean</code> | Whether to show counts of 0 or not. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.showLastTriggered">showLastTriggered</a></code> | <code>boolean</code> | Whether to show the time that has elapsed since the monitor/group triggered. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.showPriority">showPriority</a></code> | <code>boolean</code> | Whether to show the priorities column. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.start">start</a></code> | <code>number</code> | The start of the list. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.summaryType">summaryType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Which summary type should be used. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.MonitorSummaryWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.query"></a>

```typescript
public readonly query: string;
```

- *Type:* string

Query to filter the monitors with.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the monitor summary widget.

---

##### `colorPreference`<sup>Optional</sup> <a name="colorPreference" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.colorPreference"></a>

```typescript
public readonly colorPreference: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Which color to use on the widget.

---

##### `count`<sup>Optional</sup> <a name="count" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.count"></a>

```typescript
public readonly count: number;
```

- *Type:* number

The number of monitors to display.

---

##### `displayFormat`<sup>Optional</sup> <a name="displayFormat" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.displayFormat"></a>

```typescript
public readonly displayFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

What to display on the widget.

---

##### `hideZeroCounts`<sup>Optional</sup> <a name="hideZeroCounts" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.hideZeroCounts"></a>

```typescript
public readonly hideZeroCounts: boolean;
```

- *Type:* boolean

Whether to show counts of 0 or not.

---

##### `showLastTriggered`<sup>Optional</sup> <a name="showLastTriggered" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.showLastTriggered"></a>

```typescript
public readonly showLastTriggered: boolean;
```

- *Type:* boolean

Whether to show the time that has elapsed since the monitor/group triggered.

---

##### `showPriority`<sup>Optional</sup> <a name="showPriority" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.showPriority"></a>

```typescript
public readonly showPriority: boolean;
```

- *Type:* boolean

Whether to show the priorities column.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.sort"></a>

```typescript
public readonly sort: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

##### `start`<sup>Optional</sup> <a name="start" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.start"></a>

```typescript
public readonly start: number;
```

- *Type:* number

The start of the list.

Typically 0.

---

##### `summaryType`<sup>Optional</sup> <a name="summaryType" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.summaryType"></a>

```typescript
public readonly summaryType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Which summary type should be used.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.MonitorSummaryWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### NoteWidgetDefinition <a name="NoteWidgetDefinition" id="ts-interface-generator.NoteWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.NoteWidgetDefinition.Initializer"></a>

```typescript
import { NoteWidgetDefinition } from 'ts-interface-generator'

const noteWidgetDefinition: NoteWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.content">content</a></code> | <code>string</code> | Content of the note. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the note widget. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.backgroundColor">backgroundColor</a></code> | <code>string</code> | Background color of the note. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.fontSize">fontSize</a></code> | <code>string</code> | Size of the text. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.hasPadding">hasPadding</a></code> | <code>boolean</code> | Whether to add padding or not. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.showTick">showTick</a></code> | <code>boolean</code> | Whether to show a tick or not. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.textAlign">textAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.tickEdge">tickEdge</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Define how you want to align the text on the widget. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.tickPos">tickPos</a></code> | <code>string</code> | Where to position the tick on an edge. |
| <code><a href="#ts-interface-generator.NoteWidgetDefinition.property.verticalAlign">verticalAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Vertical alignment. |

---

##### `content`<sup>Required</sup> <a name="content" id="ts-interface-generator.NoteWidgetDefinition.property.content"></a>

```typescript
public readonly content: string;
```

- *Type:* string

Content of the note.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.NoteWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the note widget.

---

##### `backgroundColor`<sup>Optional</sup> <a name="backgroundColor" id="ts-interface-generator.NoteWidgetDefinition.property.backgroundColor"></a>

```typescript
public readonly backgroundColor: string;
```

- *Type:* string

Background color of the note.

---

##### `fontSize`<sup>Optional</sup> <a name="fontSize" id="ts-interface-generator.NoteWidgetDefinition.property.fontSize"></a>

```typescript
public readonly fontSize: string;
```

- *Type:* string

Size of the text.

---

##### `hasPadding`<sup>Optional</sup> <a name="hasPadding" id="ts-interface-generator.NoteWidgetDefinition.property.hasPadding"></a>

```typescript
public readonly hasPadding: boolean;
```

- *Type:* boolean

Whether to add padding or not.

---

##### `showTick`<sup>Optional</sup> <a name="showTick" id="ts-interface-generator.NoteWidgetDefinition.property.showTick"></a>

```typescript
public readonly showTick: boolean;
```

- *Type:* boolean

Whether to show a tick or not.

---

##### `textAlign`<sup>Optional</sup> <a name="textAlign" id="ts-interface-generator.NoteWidgetDefinition.property.textAlign"></a>

```typescript
public readonly textAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `tickEdge`<sup>Optional</sup> <a name="tickEdge" id="ts-interface-generator.NoteWidgetDefinition.property.tickEdge"></a>

```typescript
public readonly tickEdge: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Define how you want to align the text on the widget.

---

##### `tickPos`<sup>Optional</sup> <a name="tickPos" id="ts-interface-generator.NoteWidgetDefinition.property.tickPos"></a>

```typescript
public readonly tickPos: string;
```

- *Type:* string

Where to position the tick on an edge.

---

##### `verticalAlign`<sup>Optional</sup> <a name="verticalAlign" id="ts-interface-generator.NoteWidgetDefinition.property.verticalAlign"></a>

```typescript
public readonly verticalAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Vertical alignment.

---

### PowerpackTemplateVariableContents <a name="PowerpackTemplateVariableContents" id="ts-interface-generator.PowerpackTemplateVariableContents"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.PowerpackTemplateVariableContents.Initializer"></a>

```typescript
import { PowerpackTemplateVariableContents } from 'ts-interface-generator'

const powerpackTemplateVariableContents: PowerpackTemplateVariableContents = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.PowerpackTemplateVariableContents.property.name">name</a></code> | <code>string</code> | The name of the variable. |
| <code><a href="#ts-interface-generator.PowerpackTemplateVariableContents.property.values">values</a></code> | <code>string[]</code> | One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified. |
| <code><a href="#ts-interface-generator.PowerpackTemplateVariableContents.property.prefix">prefix</a></code> | <code>string</code> | The tag prefix associated with the variable. |

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.PowerpackTemplateVariableContents.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

The name of the variable.

---

##### `values`<sup>Required</sup> <a name="values" id="ts-interface-generator.PowerpackTemplateVariableContents.property.values"></a>

```typescript
public readonly values: string[];
```

- *Type:* string[]

One or many template variable values within the saved view, which will be unioned together using `OR` if more than one is specified.

---

##### `prefix`<sup>Optional</sup> <a name="prefix" id="ts-interface-generator.PowerpackTemplateVariableContents.property.prefix"></a>

```typescript
public readonly prefix: string;
```

- *Type:* string

The tag prefix associated with the variable.

---

### PowerpackTemplateVariables <a name="PowerpackTemplateVariables" id="ts-interface-generator.PowerpackTemplateVariables"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.PowerpackTemplateVariables.Initializer"></a>

```typescript
import { PowerpackTemplateVariables } from 'ts-interface-generator'

const powerpackTemplateVariables: PowerpackTemplateVariables = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.PowerpackTemplateVariables.property.controlledByPowerpack">controlledByPowerpack</a></code> | <code><a href="#ts-interface-generator.PowerpackTemplateVariableContents">PowerpackTemplateVariableContents</a>[]</code> | Template variables controlled at the powerpack level. |
| <code><a href="#ts-interface-generator.PowerpackTemplateVariables.property.controlledExternally">controlledExternally</a></code> | <code><a href="#ts-interface-generator.PowerpackTemplateVariableContents">PowerpackTemplateVariableContents</a>[]</code> | Template variables controlled by the external resource, such as the dashboard this powerpack is on. |

---

##### `controlledByPowerpack`<sup>Optional</sup> <a name="controlledByPowerpack" id="ts-interface-generator.PowerpackTemplateVariables.property.controlledByPowerpack"></a>

```typescript
public readonly controlledByPowerpack: PowerpackTemplateVariableContents[];
```

- *Type:* <a href="#ts-interface-generator.PowerpackTemplateVariableContents">PowerpackTemplateVariableContents</a>[]

Template variables controlled at the powerpack level.

---

##### `controlledExternally`<sup>Optional</sup> <a name="controlledExternally" id="ts-interface-generator.PowerpackTemplateVariables.property.controlledExternally"></a>

```typescript
public readonly controlledExternally: PowerpackTemplateVariableContents[];
```

- *Type:* <a href="#ts-interface-generator.PowerpackTemplateVariableContents">PowerpackTemplateVariableContents</a>[]

Template variables controlled by the external resource, such as the dashboard this powerpack is on.

---

### PowerpackWidgetDefinition <a name="PowerpackWidgetDefinition" id="ts-interface-generator.PowerpackWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.PowerpackWidgetDefinition.Initializer"></a>

```typescript
import { PowerpackWidgetDefinition } from 'ts-interface-generator'

const powerpackWidgetDefinition: PowerpackWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.powerpackId">powerpackId</a></code> | <code>string</code> | UUID of the associated powerpack. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the powerpack widget. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.backgroundColor">backgroundColor</a></code> | <code>string</code> | Background color of the powerpack title. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.bannerImg">bannerImg</a></code> | <code>string</code> | URL of image to display as a banner for the powerpack. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.showTitle">showTitle</a></code> | <code>boolean</code> | Whether to show the title or not. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.templateVariables">templateVariables</a></code> | <code><a href="#ts-interface-generator.PowerpackTemplateVariables">PowerpackTemplateVariables</a></code> | Powerpack template variables. |
| <code><a href="#ts-interface-generator.PowerpackWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |

---

##### `powerpackId`<sup>Required</sup> <a name="powerpackId" id="ts-interface-generator.PowerpackWidgetDefinition.property.powerpackId"></a>

```typescript
public readonly powerpackId: string;
```

- *Type:* string

UUID of the associated powerpack.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.PowerpackWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the powerpack widget.

---

##### `backgroundColor`<sup>Optional</sup> <a name="backgroundColor" id="ts-interface-generator.PowerpackWidgetDefinition.property.backgroundColor"></a>

```typescript
public readonly backgroundColor: string;
```

- *Type:* string

Background color of the powerpack title.

---

##### `bannerImg`<sup>Optional</sup> <a name="bannerImg" id="ts-interface-generator.PowerpackWidgetDefinition.property.bannerImg"></a>

```typescript
public readonly bannerImg: string;
```

- *Type:* string

URL of image to display as a banner for the powerpack.

---

##### `showTitle`<sup>Optional</sup> <a name="showTitle" id="ts-interface-generator.PowerpackWidgetDefinition.property.showTitle"></a>

```typescript
public readonly showTitle: boolean;
```

- *Type:* boolean

Whether to show the title or not.

---

##### `templateVariables`<sup>Optional</sup> <a name="templateVariables" id="ts-interface-generator.PowerpackWidgetDefinition.property.templateVariables"></a>

```typescript
public readonly templateVariables: PowerpackTemplateVariables;
```

- *Type:* <a href="#ts-interface-generator.PowerpackTemplateVariables">PowerpackTemplateVariables</a>

Powerpack template variables.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.PowerpackWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

### ProcessQueryDefinition <a name="ProcessQueryDefinition" id="ts-interface-generator.ProcessQueryDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ProcessQueryDefinition.Initializer"></a>

```typescript
import { ProcessQueryDefinition } from 'ts-interface-generator'

const processQueryDefinition: ProcessQueryDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ProcessQueryDefinition.property.metric">metric</a></code> | <code>string</code> | Your chosen metric. |
| <code><a href="#ts-interface-generator.ProcessQueryDefinition.property.filterBy">filterBy</a></code> | <code>string[]</code> | List of processes. |
| <code><a href="#ts-interface-generator.ProcessQueryDefinition.property.limit">limit</a></code> | <code>number</code> | Max number of items in the filter list. |
| <code><a href="#ts-interface-generator.ProcessQueryDefinition.property.searchBy">searchBy</a></code> | <code>string</code> | Your chosen search term. |

---

##### `metric`<sup>Required</sup> <a name="metric" id="ts-interface-generator.ProcessQueryDefinition.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

Your chosen metric.

---

##### `filterBy`<sup>Optional</sup> <a name="filterBy" id="ts-interface-generator.ProcessQueryDefinition.property.filterBy"></a>

```typescript
public readonly filterBy: string[];
```

- *Type:* string[]

List of processes.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.ProcessQueryDefinition.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Max number of items in the filter list.

---

##### `searchBy`<sup>Optional</sup> <a name="searchBy" id="ts-interface-generator.ProcessQueryDefinition.property.searchBy"></a>

```typescript
public readonly searchBy: string;
```

- *Type:* string

Your chosen search term.

---

### QueryValueWidgetDefinition <a name="QueryValueWidgetDefinition" id="ts-interface-generator.QueryValueWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.QueryValueWidgetDefinition.Initializer"></a>

```typescript
import { QueryValueWidgetDefinition } from 'ts-interface-generator'

const queryValueWidgetDefinition: QueryValueWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.QueryValueWidgetRequest">QueryValueWidgetRequest</a>[]</code> | Widget definition. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the query value widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.autoscale">autoscale</a></code> | <code>boolean</code> | Whether to use auto-scaling or not. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.customUnit">customUnit</a></code> | <code>string</code> | Display a unit of your choice on the widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.precision">precision</a></code> | <code>number</code> | Number of decimals to show. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.textAlign">textAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.timeseriesBackground">timeseriesBackground</a></code> | <code><a href="#ts-interface-generator.TimeseriesBackground">TimeseriesBackground</a></code> | Set a timeseries on the widget background. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.QueryValueWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: QueryValueWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.QueryValueWidgetRequest">QueryValueWidgetRequest</a>[]

Widget definition.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.QueryValueWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the query value widget.

---

##### `autoscale`<sup>Optional</sup> <a name="autoscale" id="ts-interface-generator.QueryValueWidgetDefinition.property.autoscale"></a>

```typescript
public readonly autoscale: boolean;
```

- *Type:* boolean

Whether to use auto-scaling or not.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.QueryValueWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `customUnit`<sup>Optional</sup> <a name="customUnit" id="ts-interface-generator.QueryValueWidgetDefinition.property.customUnit"></a>

```typescript
public readonly customUnit: string;
```

- *Type:* string

Display a unit of your choice on the widget.

---

##### `precision`<sup>Optional</sup> <a name="precision" id="ts-interface-generator.QueryValueWidgetDefinition.property.precision"></a>

```typescript
public readonly precision: number;
```

- *Type:* number

Number of decimals to show.

If not defined, the widget uses the raw value.

---

##### `textAlign`<sup>Optional</sup> <a name="textAlign" id="ts-interface-generator.QueryValueWidgetDefinition.property.textAlign"></a>

```typescript
public readonly textAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.QueryValueWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `timeseriesBackground`<sup>Optional</sup> <a name="timeseriesBackground" id="ts-interface-generator.QueryValueWidgetDefinition.property.timeseriesBackground"></a>

```typescript
public readonly timeseriesBackground: TimeseriesBackground;
```

- *Type:* <a href="#ts-interface-generator.TimeseriesBackground">TimeseriesBackground</a>

Set a timeseries on the widget background.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.QueryValueWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.QueryValueWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.QueryValueWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### QueryValueWidgetRequest <a name="QueryValueWidgetRequest" id="ts-interface-generator.QueryValueWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.QueryValueWidgetRequest.Initializer"></a>

```typescript
import { QueryValueWidgetRequest } from 'ts-interface-generator'

const queryValueWidgetRequest: QueryValueWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregator used for the request. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.auditQuery">auditQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.conditionalFormats">conditionalFormats</a></code> | <code><a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]</code> | List of conditional formats. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.q">q</a></code> | <code>string</code> | TODO. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.QueryValueWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.QueryValueWidgetRequest.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregator used for the request.

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `auditQuery`<sup>Optional</sup> <a name="auditQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.auditQuery"></a>

```typescript
public readonly auditQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `conditionalFormats`<sup>Optional</sup> <a name="conditionalFormats" id="ts-interface-generator.QueryValueWidgetRequest.property.conditionalFormats"></a>

```typescript
public readonly conditionalFormats: WidgetConditionalFormat[];
```

- *Type:* <a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]

List of conditional formats.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.QueryValueWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.QueryValueWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

TODO.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.QueryValueWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.QueryValueWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.QueryValueWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

### RunWorkflowWidgetDefinition <a name="RunWorkflowWidgetDefinition" id="ts-interface-generator.RunWorkflowWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.RunWorkflowWidgetDefinition.Initializer"></a>

```typescript
import { RunWorkflowWidgetDefinition } from 'ts-interface-generator'

const runWorkflowWidgetDefinition: RunWorkflowWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the run workflow widget. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.workflowId">workflowId</a></code> | <code>string</code> | Workflow id. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.inputs">inputs</a></code> | <code><a href="#ts-interface-generator.RunWorkflowWidgetInput">RunWorkflowWidgetInput</a>[]</code> | Array of workflow inputs to map to dashboard template variables. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the run workflow widget.

---

##### `workflowId`<sup>Required</sup> <a name="workflowId" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.workflowId"></a>

```typescript
public readonly workflowId: string;
```

- *Type:* string

Workflow id.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `inputs`<sup>Optional</sup> <a name="inputs" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.inputs"></a>

```typescript
public readonly inputs: RunWorkflowWidgetInput[];
```

- *Type:* <a href="#ts-interface-generator.RunWorkflowWidgetInput">RunWorkflowWidgetInput</a>[]

Array of workflow inputs to map to dashboard template variables.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.RunWorkflowWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### RunWorkflowWidgetInput <a name="RunWorkflowWidgetInput" id="ts-interface-generator.RunWorkflowWidgetInput"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.RunWorkflowWidgetInput.Initializer"></a>

```typescript
import { RunWorkflowWidgetInput } from 'ts-interface-generator'

const runWorkflowWidgetInput: RunWorkflowWidgetInput = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetInput.property.name">name</a></code> | <code>string</code> | Name of the workflow input. |
| <code><a href="#ts-interface-generator.RunWorkflowWidgetInput.property.value">value</a></code> | <code>string</code> | Dashboard template variable. |

---

##### `name`<sup>Required</sup> <a name="name" id="ts-interface-generator.RunWorkflowWidgetInput.property.name"></a>

```typescript
public readonly name: string;
```

- *Type:* string

Name of the workflow input.

---

##### `value`<sup>Required</sup> <a name="value" id="ts-interface-generator.RunWorkflowWidgetInput.property.value"></a>

```typescript
public readonly value: string;
```

- *Type:* string

Dashboard template variable.

Can be suffixed with '.value' or '.key'.

---

### ScatterPlotRequest <a name="ScatterPlotRequest" id="ts-interface-generator.ScatterPlotRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ScatterPlotRequest.Initializer"></a>

```typescript
import { ScatterPlotRequest } from 'ts-interface-generator'

const scatterPlotRequest: ScatterPlotRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregator used for the request. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.q">q</a></code> | <code>string</code> | Query definition. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ScatterPlotRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.ScatterPlotRequest.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregator used for the request.

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.ScatterPlotRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.ScatterPlotRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.ScatterPlotRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.ScatterPlotRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.ScatterPlotRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.ScatterPlotRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.ScatterPlotRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Query definition.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.ScatterPlotRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.ScatterPlotRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

### ScatterplotTableRequest <a name="ScatterplotTableRequest" id="ts-interface-generator.ScatterplotTableRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ScatterplotTableRequest.Initializer"></a>

```typescript
import { ScatterplotTableRequest } from 'ts-interface-generator'

const scatterplotTableRequest: ScatterplotTableRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ScatterplotTableRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.ScatterplotWidgetFormula">ScatterplotWidgetFormula</a>[]</code> | List of Scatterplot formulas that operate on queries. |
| <code><a href="#ts-interface-generator.ScatterplotTableRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.ScatterplotTableRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.ScatterplotTableRequest.property.formulas"></a>

```typescript
public readonly formulas: ScatterplotWidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.ScatterplotWidgetFormula">ScatterplotWidgetFormula</a>[]

List of Scatterplot formulas that operate on queries.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.ScatterplotTableRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.ScatterplotTableRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

### ScatterPlotWidgetDefinition <a name="ScatterPlotWidgetDefinition" id="ts-interface-generator.ScatterPlotWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ScatterPlotWidgetDefinition.Initializer"></a>

```typescript
import { ScatterPlotWidgetDefinition } from 'ts-interface-generator'

const scatterPlotWidgetDefinition: ScatterPlotWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinitionRequests">ScatterPlotWidgetDefinitionRequests</a></code> | Widget definition. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the scatter plot widget. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.colorByGroups">colorByGroups</a></code> | <code>string[]</code> | List of groups used for colors. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.xaxis">xaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinition.property.yaxis">yaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: ScatterPlotWidgetDefinitionRequests;
```

- *Type:* <a href="#ts-interface-generator.ScatterPlotWidgetDefinitionRequests">ScatterPlotWidgetDefinitionRequests</a>

Widget definition.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the scatter plot widget.

---

##### `colorByGroups`<sup>Optional</sup> <a name="colorByGroups" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.colorByGroups"></a>

```typescript
public readonly colorByGroups: string[];
```

- *Type:* string[]

List of groups used for colors.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

##### `xaxis`<sup>Optional</sup> <a name="xaxis" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.xaxis"></a>

```typescript
public readonly xaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

##### `yaxis`<sup>Optional</sup> <a name="yaxis" id="ts-interface-generator.ScatterPlotWidgetDefinition.property.yaxis"></a>

```typescript
public readonly yaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

### ScatterPlotWidgetDefinitionRequests <a name="ScatterPlotWidgetDefinitionRequests" id="ts-interface-generator.ScatterPlotWidgetDefinitionRequests"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ScatterPlotWidgetDefinitionRequests.Initializer"></a>

```typescript
import { ScatterPlotWidgetDefinitionRequests } from 'ts-interface-generator'

const scatterPlotWidgetDefinitionRequests: ScatterPlotWidgetDefinitionRequests = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.table">table</a></code> | <code><a href="#ts-interface-generator.ScatterplotTableRequest">ScatterplotTableRequest</a></code> | Scatterplot request containing formulas and functions. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.x">x</a></code> | <code><a href="#ts-interface-generator.ScatterPlotRequest">ScatterPlotRequest</a></code> | Updated scatter plot. |
| <code><a href="#ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.y">y</a></code> | <code><a href="#ts-interface-generator.ScatterPlotRequest">ScatterPlotRequest</a></code> | Updated scatter plot. |

---

##### `table`<sup>Optional</sup> <a name="table" id="ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.table"></a>

```typescript
public readonly table: ScatterplotTableRequest;
```

- *Type:* <a href="#ts-interface-generator.ScatterplotTableRequest">ScatterplotTableRequest</a>

Scatterplot request containing formulas and functions.

---

##### `x`<sup>Optional</sup> <a name="x" id="ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.x"></a>

```typescript
public readonly x: ScatterPlotRequest;
```

- *Type:* <a href="#ts-interface-generator.ScatterPlotRequest">ScatterPlotRequest</a>

Updated scatter plot.

---

##### `y`<sup>Optional</sup> <a name="y" id="ts-interface-generator.ScatterPlotWidgetDefinitionRequests.property.y"></a>

```typescript
public readonly y: ScatterPlotRequest;
```

- *Type:* <a href="#ts-interface-generator.ScatterPlotRequest">ScatterPlotRequest</a>

Updated scatter plot.

---

### ScatterplotWidgetFormula <a name="ScatterplotWidgetFormula" id="ts-interface-generator.ScatterplotWidgetFormula"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ScatterplotWidgetFormula.Initializer"></a>

```typescript
import { ScatterplotWidgetFormula } from 'ts-interface-generator'

const scatterplotWidgetFormula: ScatterplotWidgetFormula = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ScatterplotWidgetFormula.property.dimension">dimension</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Dimension of the Scatterplot. |
| <code><a href="#ts-interface-generator.ScatterplotWidgetFormula.property.formula">formula</a></code> | <code>string</code> | String expression built from queries, formulas, and functions. |
| <code><a href="#ts-interface-generator.ScatterplotWidgetFormula.property.alias">alias</a></code> | <code>string</code> | Expression alias. |

---

##### `dimension`<sup>Required</sup> <a name="dimension" id="ts-interface-generator.ScatterplotWidgetFormula.property.dimension"></a>

```typescript
public readonly dimension: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Dimension of the Scatterplot.

---

##### `formula`<sup>Required</sup> <a name="formula" id="ts-interface-generator.ScatterplotWidgetFormula.property.formula"></a>

```typescript
public readonly formula: string;
```

- *Type:* string

String expression built from queries, formulas, and functions.

---

##### `alias`<sup>Optional</sup> <a name="alias" id="ts-interface-generator.ScatterplotWidgetFormula.property.alias"></a>

```typescript
public readonly alias: string;
```

- *Type:* string

Expression alias.

---

### ServiceMapWidgetDefinition <a name="ServiceMapWidgetDefinition" id="ts-interface-generator.ServiceMapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ServiceMapWidgetDefinition.Initializer"></a>

```typescript
import { ServiceMapWidgetDefinition } from 'ts-interface-generator'

const serviceMapWidgetDefinition: ServiceMapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.filters">filters</a></code> | <code>string[]</code> | Your environment and primary tag (or * if enabled for your account). |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.service">service</a></code> | <code>string</code> | The ID of the service you want to map. |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the service map widget. |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.title">title</a></code> | <code>string</code> | The title of your widget. |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ServiceMapWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `filters`<sup>Required</sup> <a name="filters" id="ts-interface-generator.ServiceMapWidgetDefinition.property.filters"></a>

```typescript
public readonly filters: string[];
```

- *Type:* string[]

Your environment and primary tag (or * if enabled for your account).

---

##### `service`<sup>Required</sup> <a name="service" id="ts-interface-generator.ServiceMapWidgetDefinition.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

The ID of the service you want to map.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ServiceMapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the service map widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.ServiceMapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ServiceMapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

The title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ServiceMapWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ServiceMapWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### ServiceSummaryWidgetDefinition <a name="ServiceSummaryWidgetDefinition" id="ts-interface-generator.ServiceSummaryWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ServiceSummaryWidgetDefinition.Initializer"></a>

```typescript
import { ServiceSummaryWidgetDefinition } from 'ts-interface-generator'

const serviceSummaryWidgetDefinition: ServiceSummaryWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.env">env</a></code> | <code>string</code> | APM environment. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.service">service</a></code> | <code>string</code> | APM service. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.spanName">spanName</a></code> | <code>string</code> | APM span name. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the service summary widget. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.displayFormat">displayFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Number of columns to display. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showBreakdown">showBreakdown</a></code> | <code>boolean</code> | Whether to show the latency breakdown or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showDistribution">showDistribution</a></code> | <code>boolean</code> | Whether to show the latency distribution or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showErrors">showErrors</a></code> | <code>boolean</code> | Whether to show the error metrics or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showHits">showHits</a></code> | <code>boolean</code> | Whether to show the hits metrics or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showLatency">showLatency</a></code> | <code>boolean</code> | Whether to show the latency metrics or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.showResourceList">showResourceList</a></code> | <code>boolean</code> | Whether to show the resource list or not. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.sizeFormat">sizeFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Size of the widget. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ServiceSummaryWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `env`<sup>Required</sup> <a name="env" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.env"></a>

```typescript
public readonly env: string;
```

- *Type:* string

APM environment.

---

##### `service`<sup>Required</sup> <a name="service" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

APM service.

---

##### `spanName`<sup>Required</sup> <a name="spanName" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.spanName"></a>

```typescript
public readonly spanName: string;
```

- *Type:* string

APM span name.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the service summary widget.

---

##### `displayFormat`<sup>Optional</sup> <a name="displayFormat" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.displayFormat"></a>

```typescript
public readonly displayFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Number of columns to display.

---

##### `showBreakdown`<sup>Optional</sup> <a name="showBreakdown" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showBreakdown"></a>

```typescript
public readonly showBreakdown: boolean;
```

- *Type:* boolean

Whether to show the latency breakdown or not.

---

##### `showDistribution`<sup>Optional</sup> <a name="showDistribution" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showDistribution"></a>

```typescript
public readonly showDistribution: boolean;
```

- *Type:* boolean

Whether to show the latency distribution or not.

---

##### `showErrors`<sup>Optional</sup> <a name="showErrors" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showErrors"></a>

```typescript
public readonly showErrors: boolean;
```

- *Type:* boolean

Whether to show the error metrics or not.

---

##### `showHits`<sup>Optional</sup> <a name="showHits" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showHits"></a>

```typescript
public readonly showHits: boolean;
```

- *Type:* boolean

Whether to show the hits metrics or not.

---

##### `showLatency`<sup>Optional</sup> <a name="showLatency" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showLatency"></a>

```typescript
public readonly showLatency: boolean;
```

- *Type:* boolean

Whether to show the latency metrics or not.

---

##### `showResourceList`<sup>Optional</sup> <a name="showResourceList" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.showResourceList"></a>

```typescript
public readonly showResourceList: boolean;
```

- *Type:* boolean

Whether to show the resource list or not.

---

##### `sizeFormat`<sup>Optional</sup> <a name="sizeFormat" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.sizeFormat"></a>

```typescript
public readonly sizeFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Size of the widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ServiceSummaryWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### SLOListWidgetDefinition <a name="SLOListWidgetDefinition" id="ts-interface-generator.SLOListWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SLOListWidgetDefinition.Initializer"></a>

```typescript
import { SLOListWidgetDefinition } from 'ts-interface-generator'

const sLOListWidgetDefinition: SLOListWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SLOListWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.SLOListWidgetRequest">SLOListWidgetRequest</a>[]</code> | Array of one request object to display in the widget. |
| <code><a href="#ts-interface-generator.SLOListWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the SLO List widget. |
| <code><a href="#ts-interface-generator.SLOListWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.SLOListWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.SLOListWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.SLOListWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: SLOListWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.SLOListWidgetRequest">SLOListWidgetRequest</a>[]

Array of one request object to display in the widget.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SLOListWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the SLO List widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.SLOListWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.SLOListWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.SLOListWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### SLOListWidgetQuery <a name="SLOListWidgetQuery" id="ts-interface-generator.SLOListWidgetQuery"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SLOListWidgetQuery.Initializer"></a>

```typescript
import { SLOListWidgetQuery } from 'ts-interface-generator'

const sLOListWidgetQuery: SLOListWidgetQuery = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SLOListWidgetQuery.property.queryString">queryString</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.SLOListWidgetQuery.property.limit">limit</a></code> | <code>number</code> | Maximum number of results to display in the table. |
| <code><a href="#ts-interface-generator.SLOListWidgetQuery.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a>[]</code> | Options for sorting results. |

---

##### `queryString`<sup>Required</sup> <a name="queryString" id="ts-interface-generator.SLOListWidgetQuery.property.queryString"></a>

```typescript
public readonly queryString: string;
```

- *Type:* string

Widget query.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.SLOListWidgetQuery.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Maximum number of results to display in the table.

---

##### `sort`<sup>Optional</sup> <a name="sort" id="ts-interface-generator.SLOListWidgetQuery.property.sort"></a>

```typescript
public readonly sort: WidgetFieldSort[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFieldSort">WidgetFieldSort</a>[]

Options for sorting results.

---

### SLOListWidgetRequest <a name="SLOListWidgetRequest" id="ts-interface-generator.SLOListWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SLOListWidgetRequest.Initializer"></a>

```typescript
import { SLOListWidgetRequest } from 'ts-interface-generator'

const sLOListWidgetRequest: SLOListWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SLOListWidgetRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.SLOListWidgetQuery">SLOListWidgetQuery</a></code> | Updated SLO List widget. |
| <code><a href="#ts-interface-generator.SLOListWidgetRequest.property.requestType">requestType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget request type. |

---

##### `query`<sup>Required</sup> <a name="query" id="ts-interface-generator.SLOListWidgetRequest.property.query"></a>

```typescript
public readonly query: SLOListWidgetQuery;
```

- *Type:* <a href="#ts-interface-generator.SLOListWidgetQuery">SLOListWidgetQuery</a>

Updated SLO List widget.

---

##### `requestType`<sup>Required</sup> <a name="requestType" id="ts-interface-generator.SLOListWidgetRequest.property.requestType"></a>

```typescript
public readonly requestType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget request type.

---

### SLOWidgetDefinition <a name="SLOWidgetDefinition" id="ts-interface-generator.SLOWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SLOWidgetDefinition.Initializer"></a>

```typescript
import { SLOWidgetDefinition } from 'ts-interface-generator'

const sLOWidgetDefinition: SLOWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the SLO widget. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.viewType">viewType</a></code> | <code>string</code> | Type of view displayed by the widget. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.additionalQueryFilters">additionalQueryFilters</a></code> | <code>string</code> | Additional filters applied to the SLO query. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.globalTimeTarget">globalTimeTarget</a></code> | <code>string</code> | Defined global time target. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.showErrorBudget">showErrorBudget</a></code> | <code>boolean</code> | Defined error budget. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.sloId">sloId</a></code> | <code>string</code> | ID of the SLO displayed. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.timeWindows">timeWindows</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string[]</code> | Times being monitored. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of the widget. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |
| <code><a href="#ts-interface-generator.SLOWidgetDefinition.property.viewMode">viewMode</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Define how you want the SLO to be displayed. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SLOWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the SLO widget.

---

##### `viewType`<sup>Required</sup> <a name="viewType" id="ts-interface-generator.SLOWidgetDefinition.property.viewType"></a>

```typescript
public readonly viewType: string;
```

- *Type:* string

Type of view displayed by the widget.

---

##### `additionalQueryFilters`<sup>Optional</sup> <a name="additionalQueryFilters" id="ts-interface-generator.SLOWidgetDefinition.property.additionalQueryFilters"></a>

```typescript
public readonly additionalQueryFilters: string;
```

- *Type:* string

Additional filters applied to the SLO query.

---

##### `globalTimeTarget`<sup>Optional</sup> <a name="globalTimeTarget" id="ts-interface-generator.SLOWidgetDefinition.property.globalTimeTarget"></a>

```typescript
public readonly globalTimeTarget: string;
```

- *Type:* string

Defined global time target.

---

##### `showErrorBudget`<sup>Optional</sup> <a name="showErrorBudget" id="ts-interface-generator.SLOWidgetDefinition.property.showErrorBudget"></a>

```typescript
public readonly showErrorBudget: boolean;
```

- *Type:* boolean

Defined error budget.

---

##### `sloId`<sup>Optional</sup> <a name="sloId" id="ts-interface-generator.SLOWidgetDefinition.property.sloId"></a>

```typescript
public readonly sloId: string;
```

- *Type:* string

ID of the SLO displayed.

---

##### `timeWindows`<sup>Optional</sup> <a name="timeWindows" id="ts-interface-generator.SLOWidgetDefinition.property.timeWindows"></a>

```typescript
public readonly timeWindows: UnparsedObject | string[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string[]

Times being monitored.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.SLOWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of the widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.SLOWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.SLOWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

##### `viewMode`<sup>Optional</sup> <a name="viewMode" id="ts-interface-generator.SLOWidgetDefinition.property.viewMode"></a>

```typescript
public readonly viewMode: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Define how you want the SLO to be displayed.

---

### SplitConfig <a name="SplitConfig" id="ts-interface-generator.SplitConfig"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitConfig.Initializer"></a>

```typescript
import { SplitConfig } from 'ts-interface-generator'

const splitConfig: SplitConfig = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitConfig.property.limit">limit</a></code> | <code>number</code> | Maximum number of graphs to display in the widget. |
| <code><a href="#ts-interface-generator.SplitConfig.property.sort">sort</a></code> | <code><a href="#ts-interface-generator.SplitSort">SplitSort</a></code> | Controls the order in which graphs appear in the split. |
| <code><a href="#ts-interface-generator.SplitConfig.property.splitDimensions">splitDimensions</a></code> | <code><a href="#ts-interface-generator.SplitDimension">SplitDimension</a>[]</code> | The dimension(s) on which to split the graph. |
| <code><a href="#ts-interface-generator.SplitConfig.property.staticSplits">staticSplits</a></code> | <code><a href="#ts-interface-generator.SplitVectorEntryItem">SplitVectorEntryItem</a>[][]</code> | Manual selection of tags making split graph widget static. |

---

##### `limit`<sup>Required</sup> <a name="limit" id="ts-interface-generator.SplitConfig.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

Maximum number of graphs to display in the widget.

---

##### `sort`<sup>Required</sup> <a name="sort" id="ts-interface-generator.SplitConfig.property.sort"></a>

```typescript
public readonly sort: SplitSort;
```

- *Type:* <a href="#ts-interface-generator.SplitSort">SplitSort</a>

Controls the order in which graphs appear in the split.

---

##### `splitDimensions`<sup>Required</sup> <a name="splitDimensions" id="ts-interface-generator.SplitConfig.property.splitDimensions"></a>

```typescript
public readonly splitDimensions: SplitDimension[];
```

- *Type:* <a href="#ts-interface-generator.SplitDimension">SplitDimension</a>[]

The dimension(s) on which to split the graph.

---

##### `staticSplits`<sup>Optional</sup> <a name="staticSplits" id="ts-interface-generator.SplitConfig.property.staticSplits"></a>

```typescript
public readonly staticSplits: SplitVectorEntryItem[][];
```

- *Type:* <a href="#ts-interface-generator.SplitVectorEntryItem">SplitVectorEntryItem</a>[][]

Manual selection of tags making split graph widget static.

---

### SplitConfigSortCompute <a name="SplitConfigSortCompute" id="ts-interface-generator.SplitConfigSortCompute"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitConfigSortCompute.Initializer"></a>

```typescript
import { SplitConfigSortCompute } from 'ts-interface-generator'

const splitConfigSortCompute: SplitConfigSortCompute = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitConfigSortCompute.property.aggregation">aggregation</a></code> | <code>string</code> | How to aggregate the sort metric for the purposes of ordering. |
| <code><a href="#ts-interface-generator.SplitConfigSortCompute.property.metric">metric</a></code> | <code>string</code> | The metric to use for sorting graphs. |

---

##### `aggregation`<sup>Required</sup> <a name="aggregation" id="ts-interface-generator.SplitConfigSortCompute.property.aggregation"></a>

```typescript
public readonly aggregation: string;
```

- *Type:* string

How to aggregate the sort metric for the purposes of ordering.

---

##### `metric`<sup>Required</sup> <a name="metric" id="ts-interface-generator.SplitConfigSortCompute.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

The metric to use for sorting graphs.

---

### SplitDimension <a name="SplitDimension" id="ts-interface-generator.SplitDimension"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitDimension.Initializer"></a>

```typescript
import { SplitDimension } from 'ts-interface-generator'

const splitDimension: SplitDimension = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitDimension.property.oneGraphPer">oneGraphPer</a></code> | <code>string</code> | The system interprets this attribute differently depending on the data source of the query being split. |

---

##### `oneGraphPer`<sup>Required</sup> <a name="oneGraphPer" id="ts-interface-generator.SplitDimension.property.oneGraphPer"></a>

```typescript
public readonly oneGraphPer: string;
```

- *Type:* string

The system interprets this attribute differently depending on the data source of the query being split.

For metrics, it's a tag. For the events platform, it's an attribute or tag.

---

### SplitGraphWidgetDefinition <a name="SplitGraphWidgetDefinition" id="ts-interface-generator.SplitGraphWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitGraphWidgetDefinition.Initializer"></a>

```typescript
import { SplitGraphWidgetDefinition } from 'ts-interface-generator'

const splitGraphWidgetDefinition: SplitGraphWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.size">size</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Size of the individual graphs in the split. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.sourceWidgetDefinition">sourceWidgetDefinition</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.ChangeWidgetDefinition">ChangeWidgetDefinition</a> \| <a href="#ts-interface-generator.GeomapWidgetDefinition">GeomapWidgetDefinition</a> \| <a href="#ts-interface-generator.QueryValueWidgetDefinition">QueryValueWidgetDefinition</a> \| <a href="#ts-interface-generator.ScatterPlotWidgetDefinition">ScatterPlotWidgetDefinition</a> \| <a href="#ts-interface-generator.SunburstWidgetDefinition">SunburstWidgetDefinition</a> \| <a href="#ts-interface-generator.TableWidgetDefinition">TableWidgetDefinition</a> \| <a href="#ts-interface-generator.TimeseriesWidgetDefinition">TimeseriesWidgetDefinition</a> \| <a href="#ts-interface-generator.ToplistWidgetDefinition">ToplistWidgetDefinition</a> \| <a href="#ts-interface-generator.TreeMapWidgetDefinition">TreeMapWidgetDefinition</a></code> | The original widget we are splitting on. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.splitConfig">splitConfig</a></code> | <code><a href="#ts-interface-generator.SplitConfig">SplitConfig</a></code> | Encapsulates all user choices about how to split a graph. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the split graph widget. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.hasUniformYAxes">hasUniformYAxes</a></code> | <code>boolean</code> | Normalize y axes across graphs. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.SplitGraphWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |

---

##### `size`<sup>Required</sup> <a name="size" id="ts-interface-generator.SplitGraphWidgetDefinition.property.size"></a>

```typescript
public readonly size: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Size of the individual graphs in the split.

---

##### `sourceWidgetDefinition`<sup>Required</sup> <a name="sourceWidgetDefinition" id="ts-interface-generator.SplitGraphWidgetDefinition.property.sourceWidgetDefinition"></a>

```typescript
public readonly sourceWidgetDefinition: UnparsedObject | ChangeWidgetDefinition | GeomapWidgetDefinition | QueryValueWidgetDefinition | ScatterPlotWidgetDefinition | SunburstWidgetDefinition | TableWidgetDefinition | TimeseriesWidgetDefinition | ToplistWidgetDefinition | TreeMapWidgetDefinition;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.ChangeWidgetDefinition">ChangeWidgetDefinition</a> | <a href="#ts-interface-generator.GeomapWidgetDefinition">GeomapWidgetDefinition</a> | <a href="#ts-interface-generator.QueryValueWidgetDefinition">QueryValueWidgetDefinition</a> | <a href="#ts-interface-generator.ScatterPlotWidgetDefinition">ScatterPlotWidgetDefinition</a> | <a href="#ts-interface-generator.SunburstWidgetDefinition">SunburstWidgetDefinition</a> | <a href="#ts-interface-generator.TableWidgetDefinition">TableWidgetDefinition</a> | <a href="#ts-interface-generator.TimeseriesWidgetDefinition">TimeseriesWidgetDefinition</a> | <a href="#ts-interface-generator.ToplistWidgetDefinition">ToplistWidgetDefinition</a> | <a href="#ts-interface-generator.TreeMapWidgetDefinition">TreeMapWidgetDefinition</a>

The original widget we are splitting on.

---

##### `splitConfig`<sup>Required</sup> <a name="splitConfig" id="ts-interface-generator.SplitGraphWidgetDefinition.property.splitConfig"></a>

```typescript
public readonly splitConfig: SplitConfig;
```

- *Type:* <a href="#ts-interface-generator.SplitConfig">SplitConfig</a>

Encapsulates all user choices about how to split a graph.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SplitGraphWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the split graph widget.

---

##### `hasUniformYAxes`<sup>Optional</sup> <a name="hasUniformYAxes" id="ts-interface-generator.SplitGraphWidgetDefinition.property.hasUniformYAxes"></a>

```typescript
public readonly hasUniformYAxes: boolean;
```

- *Type:* boolean

Normalize y axes across graphs.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.SplitGraphWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.SplitGraphWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

### SplitSort <a name="SplitSort" id="ts-interface-generator.SplitSort"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitSort.Initializer"></a>

```typescript
import { SplitSort } from 'ts-interface-generator'

const splitSort: SplitSort = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitSort.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |
| <code><a href="#ts-interface-generator.SplitSort.property.compute">compute</a></code> | <code><a href="#ts-interface-generator.SplitConfigSortCompute">SplitConfigSortCompute</a></code> | Defines the metric and aggregation used as the sort value. |

---

##### `order`<sup>Required</sup> <a name="order" id="ts-interface-generator.SplitSort.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

##### `compute`<sup>Optional</sup> <a name="compute" id="ts-interface-generator.SplitSort.property.compute"></a>

```typescript
public readonly compute: SplitConfigSortCompute;
```

- *Type:* <a href="#ts-interface-generator.SplitConfigSortCompute">SplitConfigSortCompute</a>

Defines the metric and aggregation used as the sort value.

---

### SplitVectorEntryItem <a name="SplitVectorEntryItem" id="ts-interface-generator.SplitVectorEntryItem"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SplitVectorEntryItem.Initializer"></a>

```typescript
import { SplitVectorEntryItem } from 'ts-interface-generator'

const splitVectorEntryItem: SplitVectorEntryItem = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SplitVectorEntryItem.property.tagKey">tagKey</a></code> | <code>string</code> | The tag key. |
| <code><a href="#ts-interface-generator.SplitVectorEntryItem.property.tagValues">tagValues</a></code> | <code>string[]</code> | The tag values. |

---

##### `tagKey`<sup>Required</sup> <a name="tagKey" id="ts-interface-generator.SplitVectorEntryItem.property.tagKey"></a>

```typescript
public readonly tagKey: string;
```

- *Type:* string

The tag key.

---

##### `tagValues`<sup>Required</sup> <a name="tagValues" id="ts-interface-generator.SplitVectorEntryItem.property.tagValues"></a>

```typescript
public readonly tagValues: string[];
```

- *Type:* string[]

The tag values.

---

### SunburstWidgetDefinition <a name="SunburstWidgetDefinition" id="ts-interface-generator.SunburstWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SunburstWidgetDefinition.Initializer"></a>

```typescript
import { SunburstWidgetDefinition } from 'ts-interface-generator'

const sunburstWidgetDefinition: SunburstWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.SunburstWidgetRequest">SunburstWidgetRequest</a>[]</code> | List of sunburst widget requests. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the Sunburst widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.hideTotal">hideTotal</a></code> | <code>boolean</code> | Show the total value in this widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.legend">legend</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.SunburstWidgetLegendTable">SunburstWidgetLegendTable</a> \| <a href="#ts-interface-generator.SunburstWidgetLegendInlineAutomatic">SunburstWidgetLegendInlineAutomatic</a></code> | Configuration of the legend. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.SunburstWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: SunburstWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.SunburstWidgetRequest">SunburstWidgetRequest</a>[]

List of sunburst widget requests.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SunburstWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the Sunburst widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.SunburstWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `hideTotal`<sup>Optional</sup> <a name="hideTotal" id="ts-interface-generator.SunburstWidgetDefinition.property.hideTotal"></a>

```typescript
public readonly hideTotal: boolean;
```

- *Type:* boolean

Show the total value in this widget.

---

##### `legend`<sup>Optional</sup> <a name="legend" id="ts-interface-generator.SunburstWidgetDefinition.property.legend"></a>

```typescript
public readonly legend: UnparsedObject | SunburstWidgetLegendTable | SunburstWidgetLegendInlineAutomatic;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.SunburstWidgetLegendTable">SunburstWidgetLegendTable</a> | <a href="#ts-interface-generator.SunburstWidgetLegendInlineAutomatic">SunburstWidgetLegendInlineAutomatic</a>

Configuration of the legend.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.SunburstWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.SunburstWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.SunburstWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.SunburstWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### SunburstWidgetLegendInlineAutomatic <a name="SunburstWidgetLegendInlineAutomatic" id="ts-interface-generator.SunburstWidgetLegendInlineAutomatic"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SunburstWidgetLegendInlineAutomatic.Initializer"></a>

```typescript
import { SunburstWidgetLegendInlineAutomatic } from 'ts-interface-generator'

const sunburstWidgetLegendInlineAutomatic: SunburstWidgetLegendInlineAutomatic = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Whether to show the legend inline or let it be automatically generated. |
| <code><a href="#ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.hidePercent">hidePercent</a></code> | <code>boolean</code> | Whether to hide the percentages of the groups. |
| <code><a href="#ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.hideValue">hideValue</a></code> | <code>boolean</code> | Whether to hide the values of the groups. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Whether to show the legend inline or let it be automatically generated.

---

##### `hidePercent`<sup>Optional</sup> <a name="hidePercent" id="ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.hidePercent"></a>

```typescript
public readonly hidePercent: boolean;
```

- *Type:* boolean

Whether to hide the percentages of the groups.

---

##### `hideValue`<sup>Optional</sup> <a name="hideValue" id="ts-interface-generator.SunburstWidgetLegendInlineAutomatic.property.hideValue"></a>

```typescript
public readonly hideValue: boolean;
```

- *Type:* boolean

Whether to hide the values of the groups.

---

### SunburstWidgetLegendTable <a name="SunburstWidgetLegendTable" id="ts-interface-generator.SunburstWidgetLegendTable"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SunburstWidgetLegendTable.Initializer"></a>

```typescript
import { SunburstWidgetLegendTable } from 'ts-interface-generator'

const sunburstWidgetLegendTable: SunburstWidgetLegendTable = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SunburstWidgetLegendTable.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Whether or not to show a table legend. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.SunburstWidgetLegendTable.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Whether or not to show a table legend.

---

### SunburstWidgetRequest <a name="SunburstWidgetRequest" id="ts-interface-generator.SunburstWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.SunburstWidgetRequest.Initializer"></a>

```typescript
import { SunburstWidgetRequest } from 'ts-interface-generator'

const sunburstWidgetRequest: SunburstWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.auditQuery">auditQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.q">q</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.SunburstWidgetRequest.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a></code> | Widget style definition. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.SunburstWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `auditQuery`<sup>Optional</sup> <a name="auditQuery" id="ts-interface-generator.SunburstWidgetRequest.property.auditQuery"></a>

```typescript
public readonly auditQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.SunburstWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.SunburstWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.SunburstWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.SunburstWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.SunburstWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.SunburstWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.SunburstWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Widget query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.SunburstWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.SunburstWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.SunburstWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.SunburstWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.SunburstWidgetRequest.property.style"></a>

```typescript
public readonly style: WidgetStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetStyle">WidgetStyle</a>

Widget style definition.

---

### TableWidgetDefinition <a name="TableWidgetDefinition" id="ts-interface-generator.TableWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TableWidgetDefinition.Initializer"></a>

```typescript
import { TableWidgetDefinition } from 'ts-interface-generator'

const tableWidgetDefinition: TableWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.TableWidgetRequest">TableWidgetRequest</a>[]</code> | Widget definition. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the table widget. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.hasSearchBar">hasSearchBar</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Controls the display of the search bar. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.TableWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.TableWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: TableWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.TableWidgetRequest">TableWidgetRequest</a>[]

Widget definition.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.TableWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the table widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.TableWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `hasSearchBar`<sup>Optional</sup> <a name="hasSearchBar" id="ts-interface-generator.TableWidgetDefinition.property.hasSearchBar"></a>

```typescript
public readonly hasSearchBar: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Controls the display of the search bar.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.TableWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.TableWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.TableWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.TableWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### TableWidgetRequest <a name="TableWidgetRequest" id="ts-interface-generator.TableWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TableWidgetRequest.Initializer"></a>

```typescript
import { TableWidgetRequest } from 'ts-interface-generator'

const tableWidgetRequest: TableWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.aggregator">aggregator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Aggregator used for the request. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.alias">alias</a></code> | <code>string</code> | The column name (defaults to the metric name). |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.apmStatsQuery">apmStatsQuery</a></code> | <code><a href="#ts-interface-generator.ApmStatsQueryDefinition">ApmStatsQueryDefinition</a></code> | The APM stats query for table and distributions widgets. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.cellDisplayMode">cellDisplayMode</a></code> | <code>string \| <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a>[]</code> | A list of display modes for each table cell. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.conditionalFormats">conditionalFormats</a></code> | <code><a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]</code> | List of conditional formats. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.limit">limit</a></code> | <code>number</code> | For metric queries, the number of lines to show in the table. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.q">q</a></code> | <code>string</code> | Query definition. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TableWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |

---

##### `aggregator`<sup>Optional</sup> <a name="aggregator" id="ts-interface-generator.TableWidgetRequest.property.aggregator"></a>

```typescript
public readonly aggregator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Aggregator used for the request.

---

##### `alias`<sup>Optional</sup> <a name="alias" id="ts-interface-generator.TableWidgetRequest.property.alias"></a>

```typescript
public readonly alias: string;
```

- *Type:* string

The column name (defaults to the metric name).

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.TableWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `apmStatsQuery`<sup>Optional</sup> <a name="apmStatsQuery" id="ts-interface-generator.TableWidgetRequest.property.apmStatsQuery"></a>

```typescript
public readonly apmStatsQuery: ApmStatsQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ApmStatsQueryDefinition">ApmStatsQueryDefinition</a>

The APM stats query for table and distributions widgets.

---

##### `cellDisplayMode`<sup>Optional</sup> <a name="cellDisplayMode" id="ts-interface-generator.TableWidgetRequest.property.cellDisplayMode"></a>

```typescript
public readonly cellDisplayMode: string | UnparsedObject[];
```

- *Type:* string | <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a>[]

A list of display modes for each table cell.

---

##### `conditionalFormats`<sup>Optional</sup> <a name="conditionalFormats" id="ts-interface-generator.TableWidgetRequest.property.conditionalFormats"></a>

```typescript
public readonly conditionalFormats: WidgetConditionalFormat[];
```

- *Type:* <a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]

List of conditional formats.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.TableWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.TableWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.TableWidgetRequest.property.limit"></a>

```typescript
public readonly limit: number;
```

- *Type:* number

For metric queries, the number of lines to show in the table.

Only one request should have this property.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.TableWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.TableWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `order`<sup>Optional</sup> <a name="order" id="ts-interface-generator.TableWidgetRequest.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.TableWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.TableWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.TableWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Query definition.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.TableWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.TableWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.TableWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.TableWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

### TimeseriesBackground <a name="TimeseriesBackground" id="ts-interface-generator.TimeseriesBackground"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TimeseriesBackground.Initializer"></a>

```typescript
import { TimeseriesBackground } from 'ts-interface-generator'

const timeseriesBackground: TimeseriesBackground = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TimeseriesBackground.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries is made using an area or bars. |
| <code><a href="#ts-interface-generator.TimeseriesBackground.property.yaxis">yaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.TimeseriesBackground.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries is made using an area or bars.

---

##### `yaxis`<sup>Optional</sup> <a name="yaxis" id="ts-interface-generator.TimeseriesBackground.property.yaxis"></a>

```typescript
public readonly yaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

### TimeseriesWidgetDefinition <a name="TimeseriesWidgetDefinition" id="ts-interface-generator.TimeseriesWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TimeseriesWidgetDefinition.Initializer"></a>

```typescript
import { TimeseriesWidgetDefinition } from 'ts-interface-generator'

const timeseriesWidgetDefinition: TimeseriesWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.TimeseriesWidgetRequest">TimeseriesWidgetRequest</a>[]</code> | List of timeseries widget requests. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the timeseries widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.events">events</a></code> | <code><a href="#ts-interface-generator.WidgetEvent">WidgetEvent</a>[]</code> | List of widget events. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.legendColumns">legendColumns</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string[]</code> | Columns displayed in the legend. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.legendLayout">legendLayout</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Layout of the legend. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.legendSize">legendSize</a></code> | <code>string</code> | Available legend sizes for a widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.markers">markers</a></code> | <code><a href="#ts-interface-generator.WidgetMarker">WidgetMarker</a>[]</code> | List of markers. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.rightYaxis">rightYaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.showLegend">showLegend</a></code> | <code>boolean</code> | (screenboard only) Show the legend for this widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetDefinition.property.yaxis">yaxis</a></code> | <code><a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a></code> | Axis controls for the widget. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.TimeseriesWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: TimeseriesWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.TimeseriesWidgetRequest">TimeseriesWidgetRequest</a>[]

List of timeseries widget requests.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.TimeseriesWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the timeseries widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.TimeseriesWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `events`<sup>Optional</sup> <a name="events" id="ts-interface-generator.TimeseriesWidgetDefinition.property.events"></a>

```typescript
public readonly events: WidgetEvent[];
```

- *Type:* <a href="#ts-interface-generator.WidgetEvent">WidgetEvent</a>[]

List of widget events.

---

##### `legendColumns`<sup>Optional</sup> <a name="legendColumns" id="ts-interface-generator.TimeseriesWidgetDefinition.property.legendColumns"></a>

```typescript
public readonly legendColumns: UnparsedObject | string[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string[]

Columns displayed in the legend.

---

##### `legendLayout`<sup>Optional</sup> <a name="legendLayout" id="ts-interface-generator.TimeseriesWidgetDefinition.property.legendLayout"></a>

```typescript
public readonly legendLayout: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Layout of the legend.

---

##### `legendSize`<sup>Optional</sup> <a name="legendSize" id="ts-interface-generator.TimeseriesWidgetDefinition.property.legendSize"></a>

```typescript
public readonly legendSize: string;
```

- *Type:* string

Available legend sizes for a widget.

Should be one of "0", "2", "4", "8", "16", or "auto".

---

##### `markers`<sup>Optional</sup> <a name="markers" id="ts-interface-generator.TimeseriesWidgetDefinition.property.markers"></a>

```typescript
public readonly markers: WidgetMarker[];
```

- *Type:* <a href="#ts-interface-generator.WidgetMarker">WidgetMarker</a>[]

List of markers.

---

##### `rightYaxis`<sup>Optional</sup> <a name="rightYaxis" id="ts-interface-generator.TimeseriesWidgetDefinition.property.rightYaxis"></a>

```typescript
public readonly rightYaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

##### `showLegend`<sup>Optional</sup> <a name="showLegend" id="ts-interface-generator.TimeseriesWidgetDefinition.property.showLegend"></a>

```typescript
public readonly showLegend: boolean;
```

- *Type:* boolean

(screenboard only) Show the legend for this widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.TimeseriesWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.TimeseriesWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.TimeseriesWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.TimeseriesWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

##### `yaxis`<sup>Optional</sup> <a name="yaxis" id="ts-interface-generator.TimeseriesWidgetDefinition.property.yaxis"></a>

```typescript
public readonly yaxis: WidgetAxis;
```

- *Type:* <a href="#ts-interface-generator.WidgetAxis">WidgetAxis</a>

Axis controls for the widget.

---

### TimeseriesWidgetExpressionAlias <a name="TimeseriesWidgetExpressionAlias" id="ts-interface-generator.TimeseriesWidgetExpressionAlias"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TimeseriesWidgetExpressionAlias.Initializer"></a>

```typescript
import { TimeseriesWidgetExpressionAlias } from 'ts-interface-generator'

const timeseriesWidgetExpressionAlias: TimeseriesWidgetExpressionAlias = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TimeseriesWidgetExpressionAlias.property.expression">expression</a></code> | <code>string</code> | Expression name. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetExpressionAlias.property.aliasName">aliasName</a></code> | <code>string</code> | Expression alias. |

---

##### `expression`<sup>Required</sup> <a name="expression" id="ts-interface-generator.TimeseriesWidgetExpressionAlias.property.expression"></a>

```typescript
public readonly expression: string;
```

- *Type:* string

Expression name.

---

##### `aliasName`<sup>Optional</sup> <a name="aliasName" id="ts-interface-generator.TimeseriesWidgetExpressionAlias.property.aliasName"></a>

```typescript
public readonly aliasName: string;
```

- *Type:* string

Expression alias.

---

### TimeseriesWidgetRequest <a name="TimeseriesWidgetRequest" id="ts-interface-generator.TimeseriesWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TimeseriesWidgetRequest.Initializer"></a>

```typescript
import { TimeseriesWidgetRequest } from 'ts-interface-generator'

const timeseriesWidgetRequest: TimeseriesWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.auditQuery">auditQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.displayType">displayType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of display to use for the request. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.metadata">metadata</a></code> | <code><a href="#ts-interface-generator.TimeseriesWidgetExpressionAlias">TimeseriesWidgetExpressionAlias</a>[]</code> | Used to define expression aliases. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.onRightYaxis">onRightYaxis</a></code> | <code>boolean</code> | Whether or not to display a second y-axis on the right. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.q">q</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.TimeseriesWidgetRequest.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetRequestStyle">WidgetRequestStyle</a></code> | Define request widget style. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `auditQuery`<sup>Optional</sup> <a name="auditQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.auditQuery"></a>

```typescript
public readonly auditQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `displayType`<sup>Optional</sup> <a name="displayType" id="ts-interface-generator.TimeseriesWidgetRequest.property.displayType"></a>

```typescript
public readonly displayType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of display to use for the request.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.TimeseriesWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `metadata`<sup>Optional</sup> <a name="metadata" id="ts-interface-generator.TimeseriesWidgetRequest.property.metadata"></a>

```typescript
public readonly metadata: TimeseriesWidgetExpressionAlias[];
```

- *Type:* <a href="#ts-interface-generator.TimeseriesWidgetExpressionAlias">TimeseriesWidgetExpressionAlias</a>[]

Used to define expression aliases.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `onRightYaxis`<sup>Optional</sup> <a name="onRightYaxis" id="ts-interface-generator.TimeseriesWidgetRequest.property.onRightYaxis"></a>

```typescript
public readonly onRightYaxis: boolean;
```

- *Type:* boolean

Whether or not to display a second y-axis on the right.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.TimeseriesWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Widget query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.TimeseriesWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.TimeseriesWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.TimeseriesWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.TimeseriesWidgetRequest.property.style"></a>

```typescript
public readonly style: WidgetRequestStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetRequestStyle">WidgetRequestStyle</a>

Define request widget style.

---

### ToplistWidgetDefinition <a name="ToplistWidgetDefinition" id="ts-interface-generator.ToplistWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ToplistWidgetDefinition.Initializer"></a>

```typescript
import { ToplistWidgetDefinition } from 'ts-interface-generator'

const toplistWidgetDefinition: ToplistWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.ToplistWidgetRequest">ToplistWidgetRequest</a>[]</code> | List of top list widget requests. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the top list widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.style">style</a></code> | <code><a href="#ts-interface-generator.ToplistWidgetStyle">ToplistWidgetStyle</a></code> | Style customization for a top list widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.ToplistWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: ToplistWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.ToplistWidgetRequest">ToplistWidgetRequest</a>[]

List of top list widget requests.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ToplistWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the top list widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.ToplistWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.ToplistWidgetDefinition.property.style"></a>

```typescript
public readonly style: ToplistWidgetStyle;
```

- *Type:* <a href="#ts-interface-generator.ToplistWidgetStyle">ToplistWidgetStyle</a>

Style customization for a top list widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.ToplistWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.ToplistWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.ToplistWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.ToplistWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### ToplistWidgetFlat <a name="ToplistWidgetFlat" id="ts-interface-generator.ToplistWidgetFlat"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ToplistWidgetFlat.Initializer"></a>

```typescript
import { ToplistWidgetFlat } from 'ts-interface-generator'

const toplistWidgetFlat: ToplistWidgetFlat = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ToplistWidgetFlat.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Top list widget flat display type. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ToplistWidgetFlat.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Top list widget flat display type.

---

### ToplistWidgetRequest <a name="ToplistWidgetRequest" id="ts-interface-generator.ToplistWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ToplistWidgetRequest.Initializer"></a>

```typescript
import { ToplistWidgetRequest } from 'ts-interface-generator'

const toplistWidgetRequest: ToplistWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.apmQuery">apmQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.auditQuery">auditQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.conditionalFormats">conditionalFormats</a></code> | <code><a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]</code> | List of conditional formats. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.eventQuery">eventQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.logQuery">logQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.networkQuery">networkQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.processQuery">processQuery</a></code> | <code><a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a></code> | The process query to use in the widget. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.profileMetricsQuery">profileMetricsQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.q">q</a></code> | <code>string</code> | Widget query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.rumQuery">rumQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.securityQuery">securityQuery</a></code> | <code><a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a></code> | The log query. |
| <code><a href="#ts-interface-generator.ToplistWidgetRequest.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetRequestStyle">WidgetRequestStyle</a></code> | Define request widget style. |

---

##### `apmQuery`<sup>Optional</sup> <a name="apmQuery" id="ts-interface-generator.ToplistWidgetRequest.property.apmQuery"></a>

```typescript
public readonly apmQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `auditQuery`<sup>Optional</sup> <a name="auditQuery" id="ts-interface-generator.ToplistWidgetRequest.property.auditQuery"></a>

```typescript
public readonly auditQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `conditionalFormats`<sup>Optional</sup> <a name="conditionalFormats" id="ts-interface-generator.ToplistWidgetRequest.property.conditionalFormats"></a>

```typescript
public readonly conditionalFormats: WidgetConditionalFormat[];
```

- *Type:* <a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]

List of conditional formats.

---

##### `eventQuery`<sup>Optional</sup> <a name="eventQuery" id="ts-interface-generator.ToplistWidgetRequest.property.eventQuery"></a>

```typescript
public readonly eventQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.ToplistWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `logQuery`<sup>Optional</sup> <a name="logQuery" id="ts-interface-generator.ToplistWidgetRequest.property.logQuery"></a>

```typescript
public readonly logQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `networkQuery`<sup>Optional</sup> <a name="networkQuery" id="ts-interface-generator.ToplistWidgetRequest.property.networkQuery"></a>

```typescript
public readonly networkQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `processQuery`<sup>Optional</sup> <a name="processQuery" id="ts-interface-generator.ToplistWidgetRequest.property.processQuery"></a>

```typescript
public readonly processQuery: ProcessQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.ProcessQueryDefinition">ProcessQueryDefinition</a>

The process query to use in the widget.

---

##### `profileMetricsQuery`<sup>Optional</sup> <a name="profileMetricsQuery" id="ts-interface-generator.ToplistWidgetRequest.property.profileMetricsQuery"></a>

```typescript
public readonly profileMetricsQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.ToplistWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Widget query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.ToplistWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.ToplistWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

##### `rumQuery`<sup>Optional</sup> <a name="rumQuery" id="ts-interface-generator.ToplistWidgetRequest.property.rumQuery"></a>

```typescript
public readonly rumQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `securityQuery`<sup>Optional</sup> <a name="securityQuery" id="ts-interface-generator.ToplistWidgetRequest.property.securityQuery"></a>

```typescript
public readonly securityQuery: LogQueryDefinition;
```

- *Type:* <a href="#ts-interface-generator.LogQueryDefinition">LogQueryDefinition</a>

The log query.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.ToplistWidgetRequest.property.style"></a>

```typescript
public readonly style: WidgetRequestStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetRequestStyle">WidgetRequestStyle</a>

Define request widget style.

---

### ToplistWidgetStacked <a name="ToplistWidgetStacked" id="ts-interface-generator.ToplistWidgetStacked"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ToplistWidgetStacked.Initializer"></a>

```typescript
import { ToplistWidgetStacked } from 'ts-interface-generator'

const toplistWidgetStacked: ToplistWidgetStacked = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ToplistWidgetStacked.property.legend">legend</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Top list widget stacked legend behavior. |
| <code><a href="#ts-interface-generator.ToplistWidgetStacked.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Top list widget stacked display type. |

---

##### `legend`<sup>Required</sup> <a name="legend" id="ts-interface-generator.ToplistWidgetStacked.property.legend"></a>

```typescript
public readonly legend: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Top list widget stacked legend behavior.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.ToplistWidgetStacked.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Top list widget stacked display type.

---

### ToplistWidgetStyle <a name="ToplistWidgetStyle" id="ts-interface-generator.ToplistWidgetStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.ToplistWidgetStyle.Initializer"></a>

```typescript
import { ToplistWidgetStyle } from 'ts-interface-generator'

const toplistWidgetStyle: ToplistWidgetStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.ToplistWidgetStyle.property.display">display</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.ToplistWidgetStacked">ToplistWidgetStacked</a> \| <a href="#ts-interface-generator.ToplistWidgetFlat">ToplistWidgetFlat</a></code> | Top list widget display options. |
| <code><a href="#ts-interface-generator.ToplistWidgetStyle.property.scaling">scaling</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Top list widget scaling definition. |

---

##### `display`<sup>Optional</sup> <a name="display" id="ts-interface-generator.ToplistWidgetStyle.property.display"></a>

```typescript
public readonly display: UnparsedObject | ToplistWidgetStacked | ToplistWidgetFlat;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.ToplistWidgetStacked">ToplistWidgetStacked</a> | <a href="#ts-interface-generator.ToplistWidgetFlat">ToplistWidgetFlat</a>

Top list widget display options.

---

##### `scaling`<sup>Optional</sup> <a name="scaling" id="ts-interface-generator.ToplistWidgetStyle.property.scaling"></a>

```typescript
public readonly scaling: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Top list widget scaling definition.

---

### TopologyMapWidgetDefinition <a name="TopologyMapWidgetDefinition" id="ts-interface-generator.TopologyMapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TopologyMapWidgetDefinition.Initializer"></a>

```typescript
import { TopologyMapWidgetDefinition } from 'ts-interface-generator'

const topologyMapWidgetDefinition: TopologyMapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.TopologyRequest">TopologyRequest</a>[]</code> | One or more Topology requests. |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the topology map widget. |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.titleAlign">titleAlign</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | How to align the text on the widget. |
| <code><a href="#ts-interface-generator.TopologyMapWidgetDefinition.property.titleSize">titleSize</a></code> | <code>string</code> | Size of the title. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.TopologyMapWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: TopologyRequest[];
```

- *Type:* <a href="#ts-interface-generator.TopologyRequest">TopologyRequest</a>[]

One or more Topology requests.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.TopologyMapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the topology map widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.TopologyMapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.TopologyMapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

##### `titleAlign`<sup>Optional</sup> <a name="titleAlign" id="ts-interface-generator.TopologyMapWidgetDefinition.property.titleAlign"></a>

```typescript
public readonly titleAlign: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

How to align the text on the widget.

---

##### `titleSize`<sup>Optional</sup> <a name="titleSize" id="ts-interface-generator.TopologyMapWidgetDefinition.property.titleSize"></a>

```typescript
public readonly titleSize: string;
```

- *Type:* string

Size of the title.

---

### TopologyQuery <a name="TopologyQuery" id="ts-interface-generator.TopologyQuery"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TopologyQuery.Initializer"></a>

```typescript
import { TopologyQuery } from 'ts-interface-generator'

const topologyQuery: TopologyQuery = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TopologyQuery.property.dataSource">dataSource</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Name of the data source. |
| <code><a href="#ts-interface-generator.TopologyQuery.property.filters">filters</a></code> | <code>string[]</code> | Your environment and primary tag (or * if enabled for your account). |
| <code><a href="#ts-interface-generator.TopologyQuery.property.service">service</a></code> | <code>string</code> | Name of the service. |

---

##### `dataSource`<sup>Optional</sup> <a name="dataSource" id="ts-interface-generator.TopologyQuery.property.dataSource"></a>

```typescript
public readonly dataSource: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Name of the data source.

---

##### `filters`<sup>Optional</sup> <a name="filters" id="ts-interface-generator.TopologyQuery.property.filters"></a>

```typescript
public readonly filters: string[];
```

- *Type:* string[]

Your environment and primary tag (or * if enabled for your account).

---

##### `service`<sup>Optional</sup> <a name="service" id="ts-interface-generator.TopologyQuery.property.service"></a>

```typescript
public readonly service: string;
```

- *Type:* string

Name of the service.

---

### TopologyRequest <a name="TopologyRequest" id="ts-interface-generator.TopologyRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TopologyRequest.Initializer"></a>

```typescript
import { TopologyRequest } from 'ts-interface-generator'

const topologyRequest: TopologyRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TopologyRequest.property.query">query</a></code> | <code><a href="#ts-interface-generator.TopologyQuery">TopologyQuery</a></code> | Query to service-based topology data sources like the service map or data streams. |
| <code><a href="#ts-interface-generator.TopologyRequest.property.requestType">requestType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget request type. |

---

##### `query`<sup>Optional</sup> <a name="query" id="ts-interface-generator.TopologyRequest.property.query"></a>

```typescript
public readonly query: TopologyQuery;
```

- *Type:* <a href="#ts-interface-generator.TopologyQuery">TopologyQuery</a>

Query to service-based topology data sources like the service map or data streams.

---

##### `requestType`<sup>Optional</sup> <a name="requestType" id="ts-interface-generator.TopologyRequest.property.requestType"></a>

```typescript
public readonly requestType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget request type.

---

### TreeMapWidgetDefinition <a name="TreeMapWidgetDefinition" id="ts-interface-generator.TreeMapWidgetDefinition"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TreeMapWidgetDefinition.Initializer"></a>

```typescript
import { TreeMapWidgetDefinition } from 'ts-interface-generator'

const treeMapWidgetDefinition: TreeMapWidgetDefinition = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.requests">requests</a></code> | <code><a href="#ts-interface-generator.TreeMapWidgetRequest">TreeMapWidgetRequest</a>[]</code> | List of treemap widget requests. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the treemap widget. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.colorBy">colorBy</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | (deprecated) The attribute formerly used to determine color in the widget. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.customLinks">customLinks</a></code> | <code><a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]</code> | List of custom links. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.groupBy">groupBy</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | (deprecated) The attribute formerly used to group elements in the widget. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.sizeBy">sizeBy</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | (deprecated) The attribute formerly used to determine size in the widget. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.time">time</a></code> | <code><a href="#ts-interface-generator.WidgetTime">WidgetTime</a></code> | Time setting for the widget. |
| <code><a href="#ts-interface-generator.TreeMapWidgetDefinition.property.title">title</a></code> | <code>string</code> | Title of your widget. |

---

##### `requests`<sup>Required</sup> <a name="requests" id="ts-interface-generator.TreeMapWidgetDefinition.property.requests"></a>

```typescript
public readonly requests: TreeMapWidgetRequest[];
```

- *Type:* <a href="#ts-interface-generator.TreeMapWidgetRequest">TreeMapWidgetRequest</a>[]

List of treemap widget requests.

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.TreeMapWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the treemap widget.

---

##### `colorBy`<sup>Optional</sup> <a name="colorBy" id="ts-interface-generator.TreeMapWidgetDefinition.property.colorBy"></a>

```typescript
public readonly colorBy: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

(deprecated) The attribute formerly used to determine color in the widget.

---

##### `customLinks`<sup>Optional</sup> <a name="customLinks" id="ts-interface-generator.TreeMapWidgetDefinition.property.customLinks"></a>

```typescript
public readonly customLinks: WidgetCustomLink[];
```

- *Type:* <a href="#ts-interface-generator.WidgetCustomLink">WidgetCustomLink</a>[]

List of custom links.

---

##### `groupBy`<sup>Optional</sup> <a name="groupBy" id="ts-interface-generator.TreeMapWidgetDefinition.property.groupBy"></a>

```typescript
public readonly groupBy: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

(deprecated) The attribute formerly used to group elements in the widget.

---

##### `sizeBy`<sup>Optional</sup> <a name="sizeBy" id="ts-interface-generator.TreeMapWidgetDefinition.property.sizeBy"></a>

```typescript
public readonly sizeBy: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

(deprecated) The attribute formerly used to determine size in the widget.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.TreeMapWidgetDefinition.property.time"></a>

```typescript
public readonly time: WidgetTime;
```

- *Type:* <a href="#ts-interface-generator.WidgetTime">WidgetTime</a>

Time setting for the widget.

---

##### `title`<sup>Optional</sup> <a name="title" id="ts-interface-generator.TreeMapWidgetDefinition.property.title"></a>

```typescript
public readonly title: string;
```

- *Type:* string

Title of your widget.

---

### TreeMapWidgetRequest <a name="TreeMapWidgetRequest" id="ts-interface-generator.TreeMapWidgetRequest"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.TreeMapWidgetRequest.Initializer"></a>

```typescript
import { TreeMapWidgetRequest } from 'ts-interface-generator'

const treeMapWidgetRequest: TreeMapWidgetRequest = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.TreeMapWidgetRequest.property.formulas">formulas</a></code> | <code><a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]</code> | List of formulas that operate on queries. |
| <code><a href="#ts-interface-generator.TreeMapWidgetRequest.property.q">q</a></code> | <code>string</code> | The widget metrics query. |
| <code><a href="#ts-interface-generator.TreeMapWidgetRequest.property.queries">queries</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> \| <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]</code> | List of queries that can be returned directly or used in formulas. |
| <code><a href="#ts-interface-generator.TreeMapWidgetRequest.property.responseFormat">responseFormat</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Timeseries, scalar, or event list response. |

---

##### `formulas`<sup>Optional</sup> <a name="formulas" id="ts-interface-generator.TreeMapWidgetRequest.property.formulas"></a>

```typescript
public readonly formulas: WidgetFormula[];
```

- *Type:* <a href="#ts-interface-generator.WidgetFormula">WidgetFormula</a>[]

List of formulas that operate on queries.

---

##### `q`<sup>Optional</sup> <a name="q" id="ts-interface-generator.TreeMapWidgetRequest.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

The widget metrics query.

---

##### `queries`<sup>Optional</sup> <a name="queries" id="ts-interface-generator.TreeMapWidgetRequest.property.queries"></a>

```typescript
public readonly queries: UnparsedObject | FormulaAndFunctionMetricQueryDefinition | FormulaAndFunctionEventQueryDefinition | FormulaAndFunctionProcessQueryDefinition | FormulaAndFunctionApmDependencyStatsQueryDefinition | FormulaAndFunctionApmResourceStatsQueryDefinition | FormulaAndFunctionSLOQueryDefinition | FormulaAndFunctionCloudCostQueryDefinition[];
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.FormulaAndFunctionMetricQueryDefinition">FormulaAndFunctionMetricQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionEventQueryDefinition">FormulaAndFunctionEventQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionProcessQueryDefinition">FormulaAndFunctionProcessQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmDependencyStatsQueryDefinition">FormulaAndFunctionApmDependencyStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionApmResourceStatsQueryDefinition">FormulaAndFunctionApmResourceStatsQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionSLOQueryDefinition">FormulaAndFunctionSLOQueryDefinition</a> | <a href="#ts-interface-generator.FormulaAndFunctionCloudCostQueryDefinition">FormulaAndFunctionCloudCostQueryDefinition</a>[]

List of queries that can be returned directly or used in formulas.

---

##### `responseFormat`<sup>Optional</sup> <a name="responseFormat" id="ts-interface-generator.TreeMapWidgetRequest.property.responseFormat"></a>

```typescript
public readonly responseFormat: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Timeseries, scalar, or event list response.

Event list response formats are supported by Geomap widgets.

---

### UnparsedObject <a name="UnparsedObject" id="ts-interface-generator.UnparsedObject"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.UnparsedObject.Initializer"></a>

```typescript
import { UnparsedObject } from 'ts-interface-generator'

const unparsedObject: UnparsedObject = { ... }
```


### Widget <a name="Widget" id="ts-interface-generator.Widget"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.Widget.Initializer"></a>

```typescript
import { Widget } from 'ts-interface-generator'

const widget: Widget = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.Widget.property.definition">definition</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| <a href="#ts-interface-generator.AlertGraphWidgetDefinition">AlertGraphWidgetDefinition</a> \| <a href="#ts-interface-generator.AlertValueWidgetDefinition">AlertValueWidgetDefinition</a> \| <a href="#ts-interface-generator.ChangeWidgetDefinition">ChangeWidgetDefinition</a> \| <a href="#ts-interface-generator.CheckStatusWidgetDefinition">CheckStatusWidgetDefinition</a> \| <a href="#ts-interface-generator.DistributionWidgetDefinition">DistributionWidgetDefinition</a> \| <a href="#ts-interface-generator.EventStreamWidgetDefinition">EventStreamWidgetDefinition</a> \| <a href="#ts-interface-generator.EventTimelineWidgetDefinition">EventTimelineWidgetDefinition</a> \| <a href="#ts-interface-generator.FreeTextWidgetDefinition">FreeTextWidgetDefinition</a> \| <a href="#ts-interface-generator.FunnelWidgetDefinition">FunnelWidgetDefinition</a> \| <a href="#ts-interface-generator.GeomapWidgetDefinition">GeomapWidgetDefinition</a> \| <a href="#ts-interface-generator.GroupWidgetDefinition">GroupWidgetDefinition</a> \| <a href="#ts-interface-generator.HeatMapWidgetDefinition">HeatMapWidgetDefinition</a> \| <a href="#ts-interface-generator.HostMapWidgetDefinition">HostMapWidgetDefinition</a> \| <a href="#ts-interface-generator.IFrameWidgetDefinition">IFrameWidgetDefinition</a> \| <a href="#ts-interface-generator.ImageWidgetDefinition">ImageWidgetDefinition</a> \| <a href="#ts-interface-generator.ListStreamWidgetDefinition">ListStreamWidgetDefinition</a> \| <a href="#ts-interface-generator.LogStreamWidgetDefinition">LogStreamWidgetDefinition</a> \| <a href="#ts-interface-generator.MonitorSummaryWidgetDefinition">MonitorSummaryWidgetDefinition</a> \| <a href="#ts-interface-generator.NoteWidgetDefinition">NoteWidgetDefinition</a> \| <a href="#ts-interface-generator.PowerpackWidgetDefinition">PowerpackWidgetDefinition</a> \| <a href="#ts-interface-generator.QueryValueWidgetDefinition">QueryValueWidgetDefinition</a> \| <a href="#ts-interface-generator.RunWorkflowWidgetDefinition">RunWorkflowWidgetDefinition</a> \| <a href="#ts-interface-generator.SLOListWidgetDefinition">SLOListWidgetDefinition</a> \| <a href="#ts-interface-generator.SLOWidgetDefinition">SLOWidgetDefinition</a> \| <a href="#ts-interface-generator.ScatterPlotWidgetDefinition">ScatterPlotWidgetDefinition</a> \| <a href="#ts-interface-generator.ServiceMapWidgetDefinition">ServiceMapWidgetDefinition</a> \| <a href="#ts-interface-generator.ServiceSummaryWidgetDefinition">ServiceSummaryWidgetDefinition</a> \| <a href="#ts-interface-generator.SplitGraphWidgetDefinition">SplitGraphWidgetDefinition</a> \| <a href="#ts-interface-generator.SunburstWidgetDefinition">SunburstWidgetDefinition</a> \| <a href="#ts-interface-generator.TableWidgetDefinition">TableWidgetDefinition</a> \| <a href="#ts-interface-generator.TimeseriesWidgetDefinition">TimeseriesWidgetDefinition</a> \| <a href="#ts-interface-generator.ToplistWidgetDefinition">ToplistWidgetDefinition</a> \| <a href="#ts-interface-generator.TopologyMapWidgetDefinition">TopologyMapWidgetDefinition</a> \| <a href="#ts-interface-generator.TreeMapWidgetDefinition">TreeMapWidgetDefinition</a></code> | [Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/). |
| <code><a href="#ts-interface-generator.Widget.property.id">id</a></code> | <code>number</code> | ID of the widget. |
| <code><a href="#ts-interface-generator.Widget.property.layout">layout</a></code> | <code><a href="#ts-interface-generator.WidgetLayout">WidgetLayout</a></code> | The layout for a widget on a `free` or **new dashboard layout** dashboard. |

---

##### `definition`<sup>Required</sup> <a name="definition" id="ts-interface-generator.Widget.property.definition"></a>

```typescript
public readonly definition: UnparsedObject | AlertGraphWidgetDefinition | AlertValueWidgetDefinition | ChangeWidgetDefinition | CheckStatusWidgetDefinition | DistributionWidgetDefinition | EventStreamWidgetDefinition | EventTimelineWidgetDefinition | FreeTextWidgetDefinition | FunnelWidgetDefinition | GeomapWidgetDefinition | GroupWidgetDefinition | HeatMapWidgetDefinition | HostMapWidgetDefinition | IFrameWidgetDefinition | ImageWidgetDefinition | ListStreamWidgetDefinition | LogStreamWidgetDefinition | MonitorSummaryWidgetDefinition | NoteWidgetDefinition | PowerpackWidgetDefinition | QueryValueWidgetDefinition | RunWorkflowWidgetDefinition | SLOListWidgetDefinition | SLOWidgetDefinition | ScatterPlotWidgetDefinition | ServiceMapWidgetDefinition | ServiceSummaryWidgetDefinition | SplitGraphWidgetDefinition | SunburstWidgetDefinition | TableWidgetDefinition | TimeseriesWidgetDefinition | ToplistWidgetDefinition | TopologyMapWidgetDefinition | TreeMapWidgetDefinition;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | <a href="#ts-interface-generator.AlertGraphWidgetDefinition">AlertGraphWidgetDefinition</a> | <a href="#ts-interface-generator.AlertValueWidgetDefinition">AlertValueWidgetDefinition</a> | <a href="#ts-interface-generator.ChangeWidgetDefinition">ChangeWidgetDefinition</a> | <a href="#ts-interface-generator.CheckStatusWidgetDefinition">CheckStatusWidgetDefinition</a> | <a href="#ts-interface-generator.DistributionWidgetDefinition">DistributionWidgetDefinition</a> | <a href="#ts-interface-generator.EventStreamWidgetDefinition">EventStreamWidgetDefinition</a> | <a href="#ts-interface-generator.EventTimelineWidgetDefinition">EventTimelineWidgetDefinition</a> | <a href="#ts-interface-generator.FreeTextWidgetDefinition">FreeTextWidgetDefinition</a> | <a href="#ts-interface-generator.FunnelWidgetDefinition">FunnelWidgetDefinition</a> | <a href="#ts-interface-generator.GeomapWidgetDefinition">GeomapWidgetDefinition</a> | <a href="#ts-interface-generator.GroupWidgetDefinition">GroupWidgetDefinition</a> | <a href="#ts-interface-generator.HeatMapWidgetDefinition">HeatMapWidgetDefinition</a> | <a href="#ts-interface-generator.HostMapWidgetDefinition">HostMapWidgetDefinition</a> | <a href="#ts-interface-generator.IFrameWidgetDefinition">IFrameWidgetDefinition</a> | <a href="#ts-interface-generator.ImageWidgetDefinition">ImageWidgetDefinition</a> | <a href="#ts-interface-generator.ListStreamWidgetDefinition">ListStreamWidgetDefinition</a> | <a href="#ts-interface-generator.LogStreamWidgetDefinition">LogStreamWidgetDefinition</a> | <a href="#ts-interface-generator.MonitorSummaryWidgetDefinition">MonitorSummaryWidgetDefinition</a> | <a href="#ts-interface-generator.NoteWidgetDefinition">NoteWidgetDefinition</a> | <a href="#ts-interface-generator.PowerpackWidgetDefinition">PowerpackWidgetDefinition</a> | <a href="#ts-interface-generator.QueryValueWidgetDefinition">QueryValueWidgetDefinition</a> | <a href="#ts-interface-generator.RunWorkflowWidgetDefinition">RunWorkflowWidgetDefinition</a> | <a href="#ts-interface-generator.SLOListWidgetDefinition">SLOListWidgetDefinition</a> | <a href="#ts-interface-generator.SLOWidgetDefinition">SLOWidgetDefinition</a> | <a href="#ts-interface-generator.ScatterPlotWidgetDefinition">ScatterPlotWidgetDefinition</a> | <a href="#ts-interface-generator.ServiceMapWidgetDefinition">ServiceMapWidgetDefinition</a> | <a href="#ts-interface-generator.ServiceSummaryWidgetDefinition">ServiceSummaryWidgetDefinition</a> | <a href="#ts-interface-generator.SplitGraphWidgetDefinition">SplitGraphWidgetDefinition</a> | <a href="#ts-interface-generator.SunburstWidgetDefinition">SunburstWidgetDefinition</a> | <a href="#ts-interface-generator.TableWidgetDefinition">TableWidgetDefinition</a> | <a href="#ts-interface-generator.TimeseriesWidgetDefinition">TimeseriesWidgetDefinition</a> | <a href="#ts-interface-generator.ToplistWidgetDefinition">ToplistWidgetDefinition</a> | <a href="#ts-interface-generator.TopologyMapWidgetDefinition">TopologyMapWidgetDefinition</a> | <a href="#ts-interface-generator.TreeMapWidgetDefinition">TreeMapWidgetDefinition</a>

[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).

---

##### `id`<sup>Optional</sup> <a name="id" id="ts-interface-generator.Widget.property.id"></a>

```typescript
public readonly id: number;
```

- *Type:* number

ID of the widget.

---

##### `layout`<sup>Optional</sup> <a name="layout" id="ts-interface-generator.Widget.property.layout"></a>

```typescript
public readonly layout: WidgetLayout;
```

- *Type:* <a href="#ts-interface-generator.WidgetLayout">WidgetLayout</a>

The layout for a widget on a `free` or **new dashboard layout** dashboard.

---

### WidgetAxis <a name="WidgetAxis" id="ts-interface-generator.WidgetAxis"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetAxis.Initializer"></a>

```typescript
import { WidgetAxis } from 'ts-interface-generator'

const widgetAxis: WidgetAxis = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetAxis.property.includeZero">includeZero</a></code> | <code>boolean</code> | Set to `true` to include zero. |
| <code><a href="#ts-interface-generator.WidgetAxis.property.label">label</a></code> | <code>string</code> | The label of the axis to display on the graph. |
| <code><a href="#ts-interface-generator.WidgetAxis.property.max">max</a></code> | <code>string</code> | Specifies maximum numeric value to show on the axis. |
| <code><a href="#ts-interface-generator.WidgetAxis.property.min">min</a></code> | <code>string</code> | Specifies minimum numeric value to show on the axis. |
| <code><a href="#ts-interface-generator.WidgetAxis.property.scale">scale</a></code> | <code>string</code> | Specifies the scale type. |

---

##### `includeZero`<sup>Optional</sup> <a name="includeZero" id="ts-interface-generator.WidgetAxis.property.includeZero"></a>

```typescript
public readonly includeZero: boolean;
```

- *Type:* boolean

Set to `true` to include zero.

---

##### `label`<sup>Optional</sup> <a name="label" id="ts-interface-generator.WidgetAxis.property.label"></a>

```typescript
public readonly label: string;
```

- *Type:* string

The label of the axis to display on the graph.

Only usable on Scatterplot Widgets.

---

##### `max`<sup>Optional</sup> <a name="max" id="ts-interface-generator.WidgetAxis.property.max"></a>

```typescript
public readonly max: string;
```

- *Type:* string

Specifies maximum numeric value to show on the axis.

Defaults to `auto`.

---

##### `min`<sup>Optional</sup> <a name="min" id="ts-interface-generator.WidgetAxis.property.min"></a>

```typescript
public readonly min: string;
```

- *Type:* string

Specifies minimum numeric value to show on the axis.

Defaults to `auto`.

---

##### `scale`<sup>Optional</sup> <a name="scale" id="ts-interface-generator.WidgetAxis.property.scale"></a>

```typescript
public readonly scale: string;
```

- *Type:* string

Specifies the scale type.

Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).

---

### WidgetConditionalFormat <a name="WidgetConditionalFormat" id="ts-interface-generator.WidgetConditionalFormat"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetConditionalFormat.Initializer"></a>

```typescript
import { WidgetConditionalFormat } from 'ts-interface-generator'

const widgetConditionalFormat: WidgetConditionalFormat = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.comparator">comparator</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Comparator to apply. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.palette">palette</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Color palette to apply. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.value">value</a></code> | <code>number</code> | Value for the comparator. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.customBgColor">customBgColor</a></code> | <code>string</code> | Color palette to apply to the background, same values available as palette. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.customFgColor">customFgColor</a></code> | <code>string</code> | Color palette to apply to the foreground, same values available as palette. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.hideValue">hideValue</a></code> | <code>boolean</code> | True hides values. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.imageUrl">imageUrl</a></code> | <code>string</code> | Displays an image as the background. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.metric">metric</a></code> | <code>string</code> | Metric from the request to correlate this conditional format with. |
| <code><a href="#ts-interface-generator.WidgetConditionalFormat.property.timeframe">timeframe</a></code> | <code>string</code> | Defines the displayed timeframe. |

---

##### `comparator`<sup>Required</sup> <a name="comparator" id="ts-interface-generator.WidgetConditionalFormat.property.comparator"></a>

```typescript
public readonly comparator: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Comparator to apply.

---

##### `palette`<sup>Required</sup> <a name="palette" id="ts-interface-generator.WidgetConditionalFormat.property.palette"></a>

```typescript
public readonly palette: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Color palette to apply.

---

##### `value`<sup>Required</sup> <a name="value" id="ts-interface-generator.WidgetConditionalFormat.property.value"></a>

```typescript
public readonly value: number;
```

- *Type:* number

Value for the comparator.

---

##### `customBgColor`<sup>Optional</sup> <a name="customBgColor" id="ts-interface-generator.WidgetConditionalFormat.property.customBgColor"></a>

```typescript
public readonly customBgColor: string;
```

- *Type:* string

Color palette to apply to the background, same values available as palette.

---

##### `customFgColor`<sup>Optional</sup> <a name="customFgColor" id="ts-interface-generator.WidgetConditionalFormat.property.customFgColor"></a>

```typescript
public readonly customFgColor: string;
```

- *Type:* string

Color palette to apply to the foreground, same values available as palette.

---

##### `hideValue`<sup>Optional</sup> <a name="hideValue" id="ts-interface-generator.WidgetConditionalFormat.property.hideValue"></a>

```typescript
public readonly hideValue: boolean;
```

- *Type:* boolean

True hides values.

---

##### `imageUrl`<sup>Optional</sup> <a name="imageUrl" id="ts-interface-generator.WidgetConditionalFormat.property.imageUrl"></a>

```typescript
public readonly imageUrl: string;
```

- *Type:* string

Displays an image as the background.

---

##### `metric`<sup>Optional</sup> <a name="metric" id="ts-interface-generator.WidgetConditionalFormat.property.metric"></a>

```typescript
public readonly metric: string;
```

- *Type:* string

Metric from the request to correlate this conditional format with.

---

##### `timeframe`<sup>Optional</sup> <a name="timeframe" id="ts-interface-generator.WidgetConditionalFormat.property.timeframe"></a>

```typescript
public readonly timeframe: string;
```

- *Type:* string

Defines the displayed timeframe.

---

### WidgetCustomLink <a name="WidgetCustomLink" id="ts-interface-generator.WidgetCustomLink"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetCustomLink.Initializer"></a>

```typescript
import { WidgetCustomLink } from 'ts-interface-generator'

const widgetCustomLink: WidgetCustomLink = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetCustomLink.property.isHidden">isHidden</a></code> | <code>boolean</code> | The flag for toggling context menu link visibility. |
| <code><a href="#ts-interface-generator.WidgetCustomLink.property.label">label</a></code> | <code>string</code> | The label for the custom link URL. |
| <code><a href="#ts-interface-generator.WidgetCustomLink.property.link">link</a></code> | <code>string</code> | The URL of the custom link. |
| <code><a href="#ts-interface-generator.WidgetCustomLink.property.overrideLabel">overrideLabel</a></code> | <code>string</code> | The label ID that refers to a context menu link. |

---

##### `isHidden`<sup>Optional</sup> <a name="isHidden" id="ts-interface-generator.WidgetCustomLink.property.isHidden"></a>

```typescript
public readonly isHidden: boolean;
```

- *Type:* boolean

The flag for toggling context menu link visibility.

---

##### `label`<sup>Optional</sup> <a name="label" id="ts-interface-generator.WidgetCustomLink.property.label"></a>

```typescript
public readonly label: string;
```

- *Type:* string

The label for the custom link URL.

Keep the label short and descriptive. Use metrics and tags as variables.

---

##### `link`<sup>Optional</sup> <a name="link" id="ts-interface-generator.WidgetCustomLink.property.link"></a>

```typescript
public readonly link: string;
```

- *Type:* string

The URL of the custom link.

URL must include `http` or `https`. A relative URL must start with `/`.

---

##### `overrideLabel`<sup>Optional</sup> <a name="overrideLabel" id="ts-interface-generator.WidgetCustomLink.property.overrideLabel"></a>

```typescript
public readonly overrideLabel: string;
```

- *Type:* string

The label ID that refers to a context menu link.

Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`.

---

### WidgetEvent <a name="WidgetEvent" id="ts-interface-generator.WidgetEvent"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetEvent.Initializer"></a>

```typescript
import { WidgetEvent } from 'ts-interface-generator'

const widgetEvent: WidgetEvent = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetEvent.property.q">q</a></code> | <code>string</code> | Query definition. |
| <code><a href="#ts-interface-generator.WidgetEvent.property.tagsExecution">tagsExecution</a></code> | <code>string</code> | The execution method for multi-value filters. |

---

##### `q`<sup>Required</sup> <a name="q" id="ts-interface-generator.WidgetEvent.property.q"></a>

```typescript
public readonly q: string;
```

- *Type:* string

Query definition.

---

##### `tagsExecution`<sup>Optional</sup> <a name="tagsExecution" id="ts-interface-generator.WidgetEvent.property.tagsExecution"></a>

```typescript
public readonly tagsExecution: string;
```

- *Type:* string

The execution method for multi-value filters.

---

### WidgetFieldSort <a name="WidgetFieldSort" id="ts-interface-generator.WidgetFieldSort"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetFieldSort.Initializer"></a>

```typescript
import { WidgetFieldSort } from 'ts-interface-generator'

const widgetFieldSort: WidgetFieldSort = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetFieldSort.property.column">column</a></code> | <code>string</code> | Facet path for the column. |
| <code><a href="#ts-interface-generator.WidgetFieldSort.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Widget sorting methods. |

---

##### `column`<sup>Required</sup> <a name="column" id="ts-interface-generator.WidgetFieldSort.property.column"></a>

```typescript
public readonly column: string;
```

- *Type:* string

Facet path for the column.

---

##### `order`<sup>Required</sup> <a name="order" id="ts-interface-generator.WidgetFieldSort.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Widget sorting methods.

---

### WidgetFormula <a name="WidgetFormula" id="ts-interface-generator.WidgetFormula"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetFormula.Initializer"></a>

```typescript
import { WidgetFormula } from 'ts-interface-generator'

const widgetFormula: WidgetFormula = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetFormula.property.formula">formula</a></code> | <code>string</code> | String expression built from queries, formulas, and functions. |
| <code><a href="#ts-interface-generator.WidgetFormula.property.alias">alias</a></code> | <code>string</code> | Expression alias. |
| <code><a href="#ts-interface-generator.WidgetFormula.property.cellDisplayMode">cellDisplayMode</a></code> | <code>string \| <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a></code> | Define a display mode for the table cell. |
| <code><a href="#ts-interface-generator.WidgetFormula.property.conditionalFormats">conditionalFormats</a></code> | <code><a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]</code> | List of conditional formats. |
| <code><a href="#ts-interface-generator.WidgetFormula.property.limit">limit</a></code> | <code><a href="#ts-interface-generator.WidgetFormulaLimit">WidgetFormulaLimit</a></code> | Options for limiting results returned. |
| <code><a href="#ts-interface-generator.WidgetFormula.property.style">style</a></code> | <code><a href="#ts-interface-generator.WidgetFormulaStyle">WidgetFormulaStyle</a></code> | Styling options for widget formulas. |

---

##### `formula`<sup>Required</sup> <a name="formula" id="ts-interface-generator.WidgetFormula.property.formula"></a>

```typescript
public readonly formula: string;
```

- *Type:* string

String expression built from queries, formulas, and functions.

---

##### `alias`<sup>Optional</sup> <a name="alias" id="ts-interface-generator.WidgetFormula.property.alias"></a>

```typescript
public readonly alias: string;
```

- *Type:* string

Expression alias.

---

##### `cellDisplayMode`<sup>Optional</sup> <a name="cellDisplayMode" id="ts-interface-generator.WidgetFormula.property.cellDisplayMode"></a>

```typescript
public readonly cellDisplayMode: string | UnparsedObject;
```

- *Type:* string | <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a>

Define a display mode for the table cell.

---

##### `conditionalFormats`<sup>Optional</sup> <a name="conditionalFormats" id="ts-interface-generator.WidgetFormula.property.conditionalFormats"></a>

```typescript
public readonly conditionalFormats: WidgetConditionalFormat[];
```

- *Type:* <a href="#ts-interface-generator.WidgetConditionalFormat">WidgetConditionalFormat</a>[]

List of conditional formats.

---

##### `limit`<sup>Optional</sup> <a name="limit" id="ts-interface-generator.WidgetFormula.property.limit"></a>

```typescript
public readonly limit: WidgetFormulaLimit;
```

- *Type:* <a href="#ts-interface-generator.WidgetFormulaLimit">WidgetFormulaLimit</a>

Options for limiting results returned.

---

##### `style`<sup>Optional</sup> <a name="style" id="ts-interface-generator.WidgetFormula.property.style"></a>

```typescript
public readonly style: WidgetFormulaStyle;
```

- *Type:* <a href="#ts-interface-generator.WidgetFormulaStyle">WidgetFormulaStyle</a>

Styling options for widget formulas.

---

### WidgetFormulaLimit <a name="WidgetFormulaLimit" id="ts-interface-generator.WidgetFormulaLimit"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetFormulaLimit.Initializer"></a>

```typescript
import { WidgetFormulaLimit } from 'ts-interface-generator'

const widgetFormulaLimit: WidgetFormulaLimit = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetFormulaLimit.property.count">count</a></code> | <code>number</code> | Number of results to return. |
| <code><a href="#ts-interface-generator.WidgetFormulaLimit.property.order">order</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Direction of sort. |

---

##### `count`<sup>Optional</sup> <a name="count" id="ts-interface-generator.WidgetFormulaLimit.property.count"></a>

```typescript
public readonly count: number;
```

- *Type:* number

Number of results to return.

---

##### `order`<sup>Optional</sup> <a name="order" id="ts-interface-generator.WidgetFormulaLimit.property.order"></a>

```typescript
public readonly order: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Direction of sort.

---

### WidgetFormulaStyle <a name="WidgetFormulaStyle" id="ts-interface-generator.WidgetFormulaStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetFormulaStyle.Initializer"></a>

```typescript
import { WidgetFormulaStyle } from 'ts-interface-generator'

const widgetFormulaStyle: WidgetFormulaStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetFormulaStyle.property.palette">palette</a></code> | <code>string</code> | The color palette used to display the formula. |
| <code><a href="#ts-interface-generator.WidgetFormulaStyle.property.paletteIndex">paletteIndex</a></code> | <code>number</code> | Index specifying which color to use within the palette. |

---

##### `palette`<sup>Optional</sup> <a name="palette" id="ts-interface-generator.WidgetFormulaStyle.property.palette"></a>

```typescript
public readonly palette: string;
```

- *Type:* string

The color palette used to display the formula.

A guide to the available color palettes can be found at https://docs.datadoghq.com/dashboards/guide/widget_colors

---

##### `paletteIndex`<sup>Optional</sup> <a name="paletteIndex" id="ts-interface-generator.WidgetFormulaStyle.property.paletteIndex"></a>

```typescript
public readonly paletteIndex: number;
```

- *Type:* number

Index specifying which color to use within the palette.

---

### WidgetLayout <a name="WidgetLayout" id="ts-interface-generator.WidgetLayout"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetLayout.Initializer"></a>

```typescript
import { WidgetLayout } from 'ts-interface-generator'

const widgetLayout: WidgetLayout = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetLayout.property.height">height</a></code> | <code>number</code> | The height of the widget. |
| <code><a href="#ts-interface-generator.WidgetLayout.property.width">width</a></code> | <code>number</code> | The width of the widget. |
| <code><a href="#ts-interface-generator.WidgetLayout.property.x">x</a></code> | <code>number</code> | The position of the widget on the x (horizontal) axis. |
| <code><a href="#ts-interface-generator.WidgetLayout.property.y">y</a></code> | <code>number</code> | The position of the widget on the y (vertical) axis. |
| <code><a href="#ts-interface-generator.WidgetLayout.property.isColumnBreak">isColumnBreak</a></code> | <code>boolean</code> | Whether the widget should be the first one on the second column in high density or not. |

---

##### `height`<sup>Required</sup> <a name="height" id="ts-interface-generator.WidgetLayout.property.height"></a>

```typescript
public readonly height: number;
```

- *Type:* number

The height of the widget.

Should be a non-negative integer.

---

##### `width`<sup>Required</sup> <a name="width" id="ts-interface-generator.WidgetLayout.property.width"></a>

```typescript
public readonly width: number;
```

- *Type:* number

The width of the widget.

Should be a non-negative integer.

---

##### `x`<sup>Required</sup> <a name="x" id="ts-interface-generator.WidgetLayout.property.x"></a>

```typescript
public readonly x: number;
```

- *Type:* number

The position of the widget on the x (horizontal) axis.

Should be a non-negative integer.

---

##### `y`<sup>Required</sup> <a name="y" id="ts-interface-generator.WidgetLayout.property.y"></a>

```typescript
public readonly y: number;
```

- *Type:* number

The position of the widget on the y (vertical) axis.

Should be a non-negative integer.

---

##### `isColumnBreak`<sup>Optional</sup> <a name="isColumnBreak" id="ts-interface-generator.WidgetLayout.property.isColumnBreak"></a>

```typescript
public readonly isColumnBreak: boolean;
```

- *Type:* boolean

Whether the widget should be the first one on the second column in high density or not.

**Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`.

---

### WidgetMarker <a name="WidgetMarker" id="ts-interface-generator.WidgetMarker"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetMarker.Initializer"></a>

```typescript
import { WidgetMarker } from 'ts-interface-generator'

const widgetMarker: WidgetMarker = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetMarker.property.value">value</a></code> | <code>string</code> | Value to apply. |
| <code><a href="#ts-interface-generator.WidgetMarker.property.displayType">displayType</a></code> | <code>string</code> | Combination of:   - A severity error, warning, ok, or info   - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `x_axis_percentile`. |
| <code><a href="#ts-interface-generator.WidgetMarker.property.label">label</a></code> | <code>string</code> | Label to display over the marker. |
| <code><a href="#ts-interface-generator.WidgetMarker.property.time">time</a></code> | <code>string</code> | Timestamp for the widget. |

---

##### `value`<sup>Required</sup> <a name="value" id="ts-interface-generator.WidgetMarker.property.value"></a>

```typescript
public readonly value: string;
```

- *Type:* string

Value to apply.

Can be a single value y = 15 or a range of values 0 < y < 10.

---

##### `displayType`<sup>Optional</sup> <a name="displayType" id="ts-interface-generator.WidgetMarker.property.displayType"></a>

```typescript
public readonly displayType: string;
```

- *Type:* string

Combination of:   - A severity error, warning, ok, or info   - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `x_axis_percentile`.

---

##### `label`<sup>Optional</sup> <a name="label" id="ts-interface-generator.WidgetMarker.property.label"></a>

```typescript
public readonly label: string;
```

- *Type:* string

Label to display over the marker.

---

##### `time`<sup>Optional</sup> <a name="time" id="ts-interface-generator.WidgetMarker.property.time"></a>

```typescript
public readonly time: string;
```

- *Type:* string

Timestamp for the widget.

---

### WidgetRequestStyle <a name="WidgetRequestStyle" id="ts-interface-generator.WidgetRequestStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetRequestStyle.Initializer"></a>

```typescript
import { WidgetRequestStyle } from 'ts-interface-generator'

const widgetRequestStyle: WidgetRequestStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetRequestStyle.property.lineType">lineType</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of lines displayed. |
| <code><a href="#ts-interface-generator.WidgetRequestStyle.property.lineWidth">lineWidth</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Width of line displayed. |
| <code><a href="#ts-interface-generator.WidgetRequestStyle.property.palette">palette</a></code> | <code>string</code> | Color palette to apply to the widget. |

---

##### `lineType`<sup>Optional</sup> <a name="lineType" id="ts-interface-generator.WidgetRequestStyle.property.lineType"></a>

```typescript
public readonly lineType: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of lines displayed.

---

##### `lineWidth`<sup>Optional</sup> <a name="lineWidth" id="ts-interface-generator.WidgetRequestStyle.property.lineWidth"></a>

```typescript
public readonly lineWidth: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Width of line displayed.

---

##### `palette`<sup>Optional</sup> <a name="palette" id="ts-interface-generator.WidgetRequestStyle.property.palette"></a>

```typescript
public readonly palette: string;
```

- *Type:* string

Color palette to apply to the widget.

---

### WidgetStyle <a name="WidgetStyle" id="ts-interface-generator.WidgetStyle"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetStyle.Initializer"></a>

```typescript
import { WidgetStyle } from 'ts-interface-generator'

const widgetStyle: WidgetStyle = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetStyle.property.palette">palette</a></code> | <code>string</code> | Color palette to apply to the widget. |

---

##### `palette`<sup>Optional</sup> <a name="palette" id="ts-interface-generator.WidgetStyle.property.palette"></a>

```typescript
public readonly palette: string;
```

- *Type:* string

Color palette to apply to the widget.

---

### WidgetTime <a name="WidgetTime" id="ts-interface-generator.WidgetTime"></a>

#### Initializer <a name="Initializer" id="ts-interface-generator.WidgetTime.Initializer"></a>

```typescript
import { WidgetTime } from 'ts-interface-generator'

const widgetTime: WidgetTime = { ... }
```

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.WidgetTime.property.liveSpan">liveSpan</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | The available timeframes depend on the widget you are using. |

---

##### `liveSpan`<sup>Optional</sup> <a name="liveSpan" id="ts-interface-generator.WidgetTime.property.liveSpan"></a>

```typescript
public readonly liveSpan: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

The available timeframes depend on the widget you are using.

---

## Classes <a name="Classes" id="Classes"></a>

### Spec <a name="Spec" id="ts-interface-generator.Spec"></a>

#### Initializers <a name="Initializers" id="ts-interface-generator.Spec.Initializer"></a>

```typescript
import { Spec } from 'ts-interface-generator'

new Spec()
```

| **Name** | **Type** | **Description** |
| --- | --- | --- |

---

#### Methods <a name="Methods" id="Methods"></a>

| **Name** | **Description** |
| --- | --- |
| <code><a href="#ts-interface-generator.Spec.create">create</a></code> | *No description.* |

---

##### `create` <a name="create" id="ts-interface-generator.Spec.create"></a>

```typescript
public create(props: Dashboard): string
```

###### `props`<sup>Required</sup> <a name="props" id="ts-interface-generator.Spec.create.parameter.props"></a>

- *Type:* <a href="#ts-interface-generator.Dashboard">Dashboard</a>

---




## Protocols <a name="Protocols" id="Protocols"></a>

### IFrameWidgetDefinition <a name="IFrameWidgetDefinition" id="ts-interface-generator.IFrameWidgetDefinition"></a>

- *Implemented By:* <a href="#ts-interface-generator.IFrameWidgetDefinition">IFrameWidgetDefinition</a>


#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#ts-interface-generator.IFrameWidgetDefinition.property.type">type</a></code> | <code><a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> \| string</code> | Type of the iframe widget. |
| <code><a href="#ts-interface-generator.IFrameWidgetDefinition.property.url">url</a></code> | <code>string</code> | URL of the iframe. |

---

##### `type`<sup>Required</sup> <a name="type" id="ts-interface-generator.IFrameWidgetDefinition.property.type"></a>

```typescript
public readonly type: UnparsedObject | string;
```

- *Type:* <a href="#ts-interface-generator.UnparsedObject">UnparsedObject</a> | string

Type of the iframe widget.

---

##### `url`<sup>Required</sup> <a name="url" id="ts-interface-generator.IFrameWidgetDefinition.property.url"></a>

```typescript
public readonly url: string;
```

- *Type:* string

URL of the iframe.

---