# `PolarExpress.Services.EventsService`
[🔗](https://github.com/jeffhuen/polar_express/blob/main/lib/polar_express/services/events_service.ex#L2)

Events

Events API operations.

# `get_event`

```elixir
@spec get_event(PolarExpress.Client.t(), String.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.Event.t()} | {:error, PolarExpress.Error.t()}
```

Get Event

Get an event by ID.

**Scopes**: `events:read` `events:write`

See `PolarExpress.Params.EventsGetEventParams` for parameter details.

# `ingest_events`

```elixir
@spec ingest_events(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.Schemas.EventsIngestResponse.t()}
  | {:error, PolarExpress.Error.t()}
```

Ingest Events

Ingest batch of events.

**Scopes**: `events:write`

See `PolarExpress.Params.EventsIngestEventsParams` for parameter details.

# `list_event_names`

```elixir
@spec list_event_names(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}
```

List Event Names

List event names.

**Scopes**: `events:read` `events:write`

See `PolarExpress.Params.EventsListEventNamesParams` for parameter details.

# `list_events`

```elixir
@spec list_events(PolarExpress.Client.t(), map(), keyword()) ::
  {:ok, PolarExpress.ListObject.t()} | {:error, PolarExpress.Error.t()}
```

List Events

List events.

**Scopes**: `events:read` `events:write`

See `PolarExpress.Params.EventsListEventsParams` for parameter details.

---

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