# `LogpointApi.Core.Search`
[🔗](https://github.com/MikaelFangel/logpoint_api/blob/v2.2.0/lib/logpoint_api/core/search.ex#L1)

Search logs and retrieve instance data from Logpoint.

Wraps the [Search API](https://docs.logpoint.com/siem/product-docs/readme/siem_api_reference/search-api).
Use `LogpointApi.search_params/4` to build the query struct.

# `devices`

```elixir
@spec devices(LogpointApi.Data.Client.t()) :: {:ok, map()} | {:error, term()}
```

Get devices from the Logpoint instance.

# `get_id`

```elixir
@spec get_id(LogpointApi.Data.Client.t(), LogpointApi.Data.SearchParams.t()) ::
  {:ok, map()} | {:error, term()}
```

Create a search and get its search ID.

# `get_result`

```elixir
@spec get_result(LogpointApi.Data.Client.t(), String.t()) ::
  {:ok, map()} | {:error, term()}
```

Retrieve the search result for a given search ID.

# `livesearches`

```elixir
@spec livesearches(LogpointApi.Data.Client.t()) :: {:ok, map()} | {:error, term()}
```

Get live searches from the Logpoint instance.

# `loginspects`

```elixir
@spec loginspects(LogpointApi.Data.Client.t()) :: {:ok, map()} | {:error, term()}
```

Get loginspects from the Logpoint instance.

# `logpoint_repos`

```elixir
@spec logpoint_repos(LogpointApi.Data.Client.t()) :: {:ok, map()} | {:error, term()}
```

Get logpoint repos from the Logpoint instance.

# `user_preference`

```elixir
@spec user_preference(LogpointApi.Data.Client.t()) :: {:ok, map()} | {:error, term()}
```

Get user preferences from the Logpoint instance.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
