Lettermint.Types.GetRouteQuery (Lettermint v2.1.0)

Query parameters of GET /routes/{routeId} (getRoute).

Pass them as a map with nested maps for bracketed names: %{page: %{size: 10}} is sent as page[size]=10. Lists of values are joined with commas, lists of maps are indexed and booleans are sent as 1 or 0.

Parameters

include_machine (optional): Include legacy machine observations in open and click totals. Privacy opens are reported in the observed and privacy fields without this option.
include (optional)

Summary

Types

t()

Functions

__params__()

The wire names of the parameters with their decode specs.

Types

t()

@type t() :: %{
  optional(:include_machine) => boolean(),
  optional(:include) => [Lettermint.Types.GetRouteQueryIncludeItem.t()]
}

Functions

params()

The wire names of the parameters with their decode specs.