ws/ArchiveReferers

Collection of client transitions to external hosts of the platform web server: where the client came from (Referer header, utm tags), which URL was opened, IP address, and browser.

Populated by the ws microservice for external host routes ws/ExternalRoutedHosts that have the archive_referers mode enabled (in the record or in the route).

Only transitions are saved — GET requests satisfying one of the conditions:

  • the Referer header points to another host;

  • the request has utm_* parameters;

  • there is no Referer header, and the request is a page transition (the Sec-Fetch-Dest: document header or Accept containing text/html).

The browser passes the external Referer once — in the first request; page resources and internal transitions come with the Referer of their own host and are not saved.

The record is written asynchronously and does not delay the response to the client. When the storage is overloaded, some records may be skipped (with a warning in the microservice log).

Master domain only.

Storage type: history or transactionlog. Retention is not limited by the collection: outdated partitions are deleted by storage tools.

Table 1. Class fields
Field Type Description

id

uuid

Identifier

dt

datetime

Request time, UTC. Partitioning field.

ip

string

Client IP address (accounting for PROXY protocol and X-Forwarded-For from trusted addresses).

host

string

Request host (Host header). Differs from item_host for a record with host *.

item_host

string

The host value of the ws/ExternalRoutedHosts record.

item_id

uuid

Identifier of the ws/ExternalRoutedHosts record to which the route belongs.

route_type

string

Route handler type (handler): static, redirect, redirect_regex, error, proxy_http, proxy_websocket, proxy_http_ex, proxy_websocket_ex.

route_path

string

Route path template.

method

string

Request method (GET).

path

string

Request path to the platform web server.

url

string

Opened URL. In utm mode — without query parameters except utm_*; in full mode — with the full query. Up to 2048 characters.

utm

any

All utm_* request parameters (object). null if there are no tags.

utm_source

string

utm_source value.

utm_medium

string

utm_medium value.

utm_campaign

string

utm_campaign value.

referer

string

Referer header. Up to 2048 characters. null if not passed.

user_agent

string

User-Agent header. Up to 512 characters.