# API

**Kind**: interface | **Module**: [Insights](https://docs.interop.io/desktop/reference/javascript/insights/index.md) | **Access**: `io.insights`

**Source**: https://docs.interop.io/desktop/reference/javascript/insights/api/index.html

Entry point into the io.Insights API

## Properties

- **`logs`** (`LogsManager`, required)
  io.insights Logs API, often accessible as io.insights.logs
- **`metrics`** (`MetricsManager`, required)
  io.insights Metrics API, often accessible as io.insights.metrics
- **`settings`** (`Settings`, required)
  io.Insights settings
- **`started`** (`boolean`, required)
  Whether or not this instance is started.
- **`traces`** (`TracesManager`, required)
  io.insights Traces API, often accessible as io.insights.traces

## Methods

### start

Starts publishing data.

```ts
() => Promise<void>
```

**Returns**: `Promise<void>`

### stop

Stops publishing data.

```ts
() => Promise<void>
```

**Returns**: `Promise<void>`

### waitForFinalExport

Waits for any pending data to be published, with the option to specify a timeout.

```ts
(timeoutMs?: number) => Promise<void>
```

**Parameters**

- **`timeoutMs`** (`number`, optional)
  maximum time to wait for export

**Returns**: `Promise<void>`

## Related types

- [LogsManager](https://docs.interop.io/desktop/reference/javascript/insights/logsmanager/index.md)
- [MetricsManager](https://docs.interop.io/desktop/reference/javascript/insights/metricsmanager/index.md)
- [Settings](https://docs.interop.io/desktop/reference/javascript/insights/settings/index.md)
- [TracesManager](https://docs.interop.io/desktop/reference/javascript/insights/tracesmanager/index.md)