# `Ankusa.Route`
[🔗](https://github.com/jamescarr/ankusa/blob/ankusa-v0.7.0/packages/ankusa/lib/ankusa/route.ex#L1)

The resolved identity of an ingest request: which tenant and source a catch
URL maps to. Produced by a `Ankusa.RouteResolver` from the raw `Plug.Conn`, so
the URL *scheme* (single path segment, tenant-in-path, opaque token, host
routing) is a pluggable concern the rest of the framework never sees.

  * `source_id` — the key a `Ankusa.SourceStore` resolves to a `%Ankusa.Source{}`.
  * `tenant_id` — the owning tenant. `nil` means "take it from the source",
    which is the single-tenant / static-config case. A multi-tenant resolver
    that carries the tenant in the URL sets it explicitly.
  * `params` — any extra captures the resolver wants to pass through
    (e.g. an app id, a token scope). Advisory; the hot path ignores it.

# `t`

```elixir
@type t() :: %Ankusa.Route{
  params: map(),
  source_id: String.t(),
  tenant_id: String.t() | nil
}
```

---

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