Polarex.Events (Polarex v0.2.3)

View Source

Provides API endpoints related to events

Summary

Functions

events_get(id, opts \\ [])

@spec events_get(
  String.t(),
  keyword()
) ::
  {:ok, map() | Polarex.UserEvent.t()}
  | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}

Get Event

Get an event by ID.

Scopes: events:read events:write

events_ingest(body, opts \\ [])

@spec events_ingest(
  Polarex.EventsIngest.t(),
  keyword()
) ::
  {:ok, Polarex.EventsIngestResponse.t()}
  | {:error, Polarex.HTTPValidationError.t()}

Ingest Events

Ingest batch of events.

Scopes: events:write

events_list(opts \\ [])

@spec events_list(keyword()) ::
  {:ok, Polarex.ListResourceEvent.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Events

List events.

Scopes: events:read events:write

Options

  • filter: Filter events following filter clauses. JSON string following the same schema a meter filter clause.
  • start_timestamp: Filter events after this timestamp.
  • end_timestamp: Filter events before this timestamp.
  • organization_id: Filter by organization ID.
  • customer_id: Filter by customer ID.
  • external_customer_id: Filter by external customer ID.
  • meter_id: Filter by a meter filter clause.
  • name: Filter by event name.
  • source: Filter by event source.
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.
  • metadata: Filter by metadata key-value pairs. It uses the deepObject style, e.g. ?metadata[key]=value.

events_list_names(opts \\ [])

@spec events_list_names(keyword()) ::
  {:ok, Polarex.ListResourceEventName.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Event Names

List event names.

Scopes: events:read events:write

Options

  • organization_id: Filter by organization ID.
  • customer_id: Filter by customer ID.
  • external_customer_id: Filter by external customer ID.
  • source: Filter by event source.
  • query: Query to filter event names.
  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.